diff --git a/src/main/antora/modules/ROOT/pages/observability/conventions.adoc b/src/main/antora/modules/ROOT/pages/observability/conventions.adoc index 7cbd02a61..6c18493fd 100644 --- a/src/main/antora/modules/ROOT/pages/observability/conventions.adoc +++ b/src/main/antora/modules/ROOT/pages/observability/conventions.adoc @@ -1,10 +1,11 @@ [[observability-conventions]] = Conventions -Below you can find a list of all `GlobalObservabilityConventions` and `ObservabilityConventions` declared by this project. +Below you can find a list of all `GlobalObservationConvention` and `ObservationConvention` declared by this project. .ObservationConvention implementations |=== |ObservationConvention Class Name | Applicable ObservationContext Class Name -|`org.springframework.data.cassandra.observability.DefaultCassandraObservationConvention`|`n/a` +|`org.springframework.data.mongodb.observability.DefaultMongoHandlerObservationConvention`|`MongoHandlerContext` +|`org.springframework.data.mongodb.observability.MongoHandlerObservationConvention`|`MongoHandlerContext` |=== diff --git a/src/main/antora/modules/ROOT/pages/observability/metrics.adoc b/src/main/antora/modules/ROOT/pages/observability/metrics.adoc index 2c3d29808..8b5ce92a6 100644 --- a/src/main/antora/modules/ROOT/pages/observability/metrics.adoc +++ b/src/main/antora/modules/ROOT/pages/observability/metrics.adoc @@ -3,46 +3,37 @@ Below you can find a list of all metrics declared by this project. -[[observability-metrics-cassandra-query-observation]] -== Cassandra Query Observation +[[observability-metrics-mongodb-command-observation]] +== Mongodb Command Observation ____ -Create an `io.micrometer.observation.Observation` for Cassandra-based queries. +Timer created around a MongoDB command execution. ____ -**Metric name** `spring.data.cassandra.query`. **Type** `timer` and **base unit** `seconds`. +**Metric name** `spring.data.mongodb.command`. **Type** `timer`. -Fully qualified name of the enclosing class `org.springframework.data.cassandra.observability.CassandraObservation`. +**Metric name** `spring.data.mongodb.command.active`. **Type** `long task timer`. +IMPORTANT: KeyValues that are added after starting the Observation might be missing from the *.active metrics. +IMPORTANT: Micrometer internally uses `nanoseconds` for the baseunit. However, each backend determines the actual baseunit. (i.e. Prometheus uses seconds) -.Low cardinality Keys -[cols="a,a"] -|=== -|Name | Description -|`db.cassandra.coordinator.dc`| -|`db.cassandra.coordinator.id`| -|`db.name`|Name of the Cassandra keyspace. -|`db.operation`|The database operation. -|`db.system`|Database system. -|`net.peer.name`|Name of the database host. -|`net.peer.port`|Logical remote port number. -|`net.sock.peer.addr`|Cassandra peer address. -|`net.sock.peer.port`|Cassandra peer port. -|`net.transport`|Network transport. -|`spring.data.cassandra.methodName`|The method name -|`spring.data.cassandra.sessionName`|Cassandra session -|=== +Fully qualified name of the enclosing class `org.springframework.data.mongodb.observability.MongoObservation`. -.High cardinality Keys +.Low cardinality Keys [cols="a,a"] |=== |Name | Description -|`db.cassandra.consistency_level`| -|`db.cassandra.idempotence`| -|`db.cassandra.page_size`| -|`db.statement`|A key-value containing Cassandra CQL. -|`spring.data.cassandra.node[%s].error`|A tag containing error that occurred for the given node. (since the name contains `%s` the final value will be resolved at runtime) +|`db.connection_string` _(required)_|MongoDB connection string. +|`db.mongodb.collection` _(required)_|MongoDB collection name. +|`db.name` _(required)_|MongoDB database name. +|`db.operation` _(required)_|MongoDB command value. +|`db.system` _(required)_|MongoDB database system. +|`db.user` _(required)_|MongoDB user. +|`net.peer.name` _(required)_|Name of the database host. +|`net.peer.port` _(required)_|Logical remote port number. +|`net.sock.peer.addr` _(required)_|Mongo peer address. +|`net.sock.peer.port` _(required)_|Mongo peer port. +|`net.transport` _(required)_|Network transport. +|`spring.data.mongodb.cluster_id` _(required)_|MongoDB cluster identifier. |=== - - diff --git a/src/main/antora/modules/ROOT/pages/observability/spans.adoc b/src/main/antora/modules/ROOT/pages/observability/spans.adoc index a149243f7..8e79d33a8 100644 --- a/src/main/antora/modules/ROOT/pages/observability/spans.adoc +++ b/src/main/antora/modules/ROOT/pages/observability/spans.adoc @@ -3,39 +3,28 @@ Below you can find a list of all spans declared by this project. -[[observability-spans-cassandra-query-observation]] -== Cassandra Query Observation Span +[[observability-spans-mongodb-command-observation]] +== Mongodb Command Observation Span -> Create an `io.micrometer.observation.Observation` for Cassandra-based queries. - -**Span name** `spring.data.cassandra.query`. - -Fully qualified name of the enclosing class `org.springframework.data.cassandra.observability.CassandraObservation`. +> Timer created around a MongoDB command execution. +**Span name** `spring.data.mongodb.command`. +Fully qualified name of the enclosing class `org.springframework.data.mongodb.observability.MongoObservation`. .Tag Keys |=== |Name | Description -|`db.cassandra.consistency_level`| -|`db.cassandra.coordinator.dc`| -|`db.cassandra.coordinator.id`| -|`db.cassandra.idempotence`| -|`db.cassandra.page_size`| -|`db.name`|Name of the Cassandra keyspace. -|`db.operation`|The database operation. -|`db.statement`|A key-value containing Cassandra CQL. -|`db.system`|Database system. -|`net.peer.name`|Name of the database host. -|`net.peer.port`|Logical remote port number. -|`net.sock.peer.addr`|Cassandra peer address. -|`net.sock.peer.port`|Cassandra peer port. -|`net.transport`|Network transport. -|`spring.data.cassandra.methodName`|The method name -|`spring.data.cassandra.node[%s].error`|A tag containing error that occurred for the given node. (since the name contains `%s` the final value will be resolved at runtime) -|`spring.data.cassandra.sessionName`|Cassandra session +|`db.connection_string` _(required)_|MongoDB connection string. +|`db.mongodb.collection` _(required)_|MongoDB collection name. +|`db.name` _(required)_|MongoDB database name. +|`db.operation` _(required)_|MongoDB command value. +|`db.system` _(required)_|MongoDB database system. +|`db.user` _(required)_|MongoDB user. +|`net.peer.name` _(required)_|Name of the database host. +|`net.peer.port` _(required)_|Logical remote port number. +|`net.sock.peer.addr` _(required)_|Mongo peer address. +|`net.sock.peer.port` _(required)_|Mongo peer port. +|`net.transport` _(required)_|Network transport. +|`spring.data.mongodb.cluster_id` _(required)_|MongoDB cluster identifier. |=== - - - -