#diesel #logging #tracing #database #opentelemetry

diesel-tracing

Connection telemetry middleware for diesel and tracing

7 releases

0.1.6 Jun 13, 2022
0.1.5 Jun 18, 2021
0.1.4 Mar 16, 2021
0.1.3 Aug 17, 2020

#164 in Database interfaces

Download history 78/week @ 2022-06-05 169/week @ 2022-06-12 52/week @ 2022-06-19 55/week @ 2022-06-26 133/week @ 2022-07-03 33/week @ 2022-07-10 32/week @ 2022-07-17 48/week @ 2022-07-24 68/week @ 2022-07-31 107/week @ 2022-08-07 43/week @ 2022-08-14 52/week @ 2022-08-21 88/week @ 2022-08-28 293/week @ 2022-09-04 140/week @ 2022-09-11 62/week @ 2022-09-18

597 downloads per month

MIT license

23KB
428 lines

Maintenance

diesel-tracing

diesel-tracing provides connection structures that can be used as drop in replacements for diesel connections with extra tracing and logging.

Usage should be straightforward if you are already using dynamic trait objects or impl trait for your connections. For example a function such as:

fn use_connection(
    conn: &impl diesel::Connection<Backend = diesel::pg::Pg>,
) -> () {}

Will accept both diesel::PgConnection and the InstrumentedPgConnection provided by this crate and this works similarly for other implementations of Connection if you change the parametized Backend marker in the function signature.

Unfortunately there are some methods specific to backends which are not encapsulated by the diesel::Connection trait, so in those places it is likely that you will just need to replace your connection type with the Instrumented version.

Usage

Just like diesel this crate relies on some feature flags to specify which database driver to support. Just as in diesel configure this in your Cargo.toml

[dependencies]
diesel-tracing = { version = "<version>", features = ["<postgres|mysql|sqlite>"] }

Notes

Fields

Currently the few fields that are recorded are a subset of the OpenTelemetry semantic conventions for databases. This was chosen for compatibility with the tracing-opentelemetry crate, but if it makes sense for other standards to be available this could be set by feature flag later.

It would be quite useful to be able to parse connection strings to be able to provide more information, but this may be difficult if it requires use of diesel feature flags by default to access the underlying C bindings.

Levels

All logged traces are currently set to DEBUG level, potentially this could be changed to a different default or set to be configured by feature flags. At them moment this crate is quite new and it's unclear what a sensible default would be.

Errors

Errors in Result objects returned by methods on the connection should be automatically logged through the err directive in the instrument macro.

Sensitive Information

As statements may contain sensitive information they are currently not recorded explicitly, pending finding a way to filter things intelligently.

Similarly connection strings are not recorded in spans as they may contain passwords

TODO

  • Record and log connection information (filtering out sensitive fields)
  • Provide a way of filtering statements, maybe based on regex?

License: MIT

Dependencies

~2.5–6MB
~124K SLoC