Add database semantic convention section and redis server metrics #2070
+45
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding a section for semantic conventions around database metrics. Additionally capturing the redis metrics produced by the otel collector redis receiver today as a first step.
|
This PR came from the work in the collector here open-telemetry/opentelemetry-collector-contrib#5837 |
carlosalberto
approved these changes
Nov 5, 2021
arminru
added
area:semantic-conventions
jmacd
reviewed
Nov 15, 2021
|
|
||
| | Name | Instrument | Units | Description | Attribute Keys | Attributes | | ||
| |-------------------------------|----------------------------|--------------|-------------|-|-| | ||
| |`redis.uptime`|Asynchronous Counter|seconds|Number of seconds since Redis server start| |
There was a problem hiding this comment.
There is an OTEP about uptime monitoring with active debate, see
. open-telemetry/oteps#185
Comment on lines
+21
to
+23
| |`redis.clients.connected`|Asynchronous UpDownCounter||Number of client connections (excluding connections from replicas)| | | | ||
| |`redis.clients.max_input_buffer`|Asynchronous Gauge||Biggest input buffer among current client connections| | | | ||
| |`redis.clients.max_output_buffer`|Asynchronous Gauge||Biggest output list among current client connections| | | |
There was a problem hiding this comment.
These three lines are begging us to finish a specification for what Prometheus calls GaugeHistogram. There would be two asynchronous histograms for input and output buffer sizes, their counts == number of connections, their sums == total input/output size, their min and max describing the smallest and largest input/output buffers, and so on.
Since that's unlikely to happy soon, this is fine.
| |`redis.clients.connected`|Asynchronous UpDownCounter||Number of client connections (excluding connections from replicas)| | | | ||
| |`redis.clients.max_input_buffer`|Asynchronous Gauge||Biggest input buffer among current client connections| | | | ||
| |`redis.clients.max_output_buffer`|Asynchronous Gauge||Biggest output list among current client connections| | | | ||
| |`redis.clients.blocked`|Asynchronous Counter||Number of clients pending on a blocking call| | | |
| |`redis.keys.evicted`|Asynchronous Counter||Total number of evicted keys due to maxmemory limit| | | | ||
| |`redis.connections.received`|Asynchronous Counter||Total number of connections accepted by the server| | | | ||
| |`redis.connections.rejected`|Asynchronous Counter||Total number of connections rejected because of maxclients limit| | | | ||
| |`redis.memory.used`|Asynchronous Gauge|bytes|Total number of bytes allocated by Redis using its allocator| | | |
| |`redis.connections.rejected`|Asynchronous Counter||Total number of connections rejected because of maxclients limit| | | | ||
| |`redis.memory.used`|Asynchronous Gauge|bytes|Total number of bytes allocated by Redis using its allocator| | | | ||
| |`redis.memory.peak`|Asynchronous Gauge|bytes|Peak memory consumed| | | | ||
| |`redis.memory.rss`|Asynchronous Gauge|bytes|Number of bytes that Redis allocated as seen by the operating system| | | |
| |`redis.memory.used`|Asynchronous Gauge|bytes|Total number of bytes allocated by Redis using its allocator| | | | ||
| |`redis.memory.peak`|Asynchronous Gauge|bytes|Peak memory consumed| | | | ||
| |`redis.memory.rss`|Asynchronous Gauge|bytes|Number of bytes that Redis allocated as seen by the operating system| | | | ||
| |`redis.memory.lua`|Asynchronous Gauge|bytes|Number of bytes used by the Lua engine| | | |
| |`redis.memory.rss`|Asynchronous Gauge|bytes|Number of bytes that Redis allocated as seen by the operating system| | | | ||
| |`redis.memory.lua`|Asynchronous Gauge|bytes|Number of bytes used by the Lua engine| | | | ||
| |`redis.memory.fragmentation_ratio`|Asynchronous Gauge||Ratio between used_memory_rss and used_memory| | | | ||
| |`redis.rdb.changes_since_last_save`|Asynchronous UpDownCounter||Number of changes since the last dump| | | |
There was a problem hiding this comment.
Sounds like Synchronous UpDownCounter.
| |`redis.memory.lua`|Asynchronous Gauge|bytes|Number of bytes used by the Lua engine| | | | ||
| |`redis.memory.fragmentation_ratio`|Asynchronous Gauge||Ratio between used_memory_rss and used_memory| | | | ||
| |`redis.rdb.changes_since_last_save`|Asynchronous UpDownCounter||Number of changes since the last dump| | | | ||
| |`redis.commands`|Asynchronous Gauge|operations per second|Number of commands processed per second| | | |
There was a problem hiding this comment.
I suggest removing this, it's defined by the rate of redis.commands.processed.
Comment on lines
+37
to
+38
| |`redis.net.input`|Asynchronous Counter|bytes|The total number of bytes read from the network| | | | ||
| |`redis.net.output`|Asynchronous Counter|bytes|The total number of bytes written to the network| | | |
There was a problem hiding this comment.
The semantic conventions say to use .io with a direction attribute: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/README.md#instrument-naming
| |`redis.net.output`|Asynchronous Counter|bytes|The total number of bytes written to the network| | | | ||
| |`redis.keyspace.hits`|Asynchronous Counter||Number of successful lookup of keys in the main dictionary| | | | ||
| |`redis.keyspace.misses`|Asynchronous Counter||Number of failed lookup of keys in the main dictionary| | | | ||
| |`redis.latest_fork`|Asynchronous Gauge|microseconds|Duration of the latest fork operation| | | |
There was a problem hiding this comment.
Should this be redis.latest_fork.duration?
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
|
Closed as inactive. Feel free to reopen if this PR is still being worked on. |
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Adding a section for semantic conventions around database metrics. Additionally capturing the redis metrics produced by the otel collector redis receiver today as a first step.
Related issues # open-telemetry/semantic-conventions#707