-
Notifications
You must be signed in to change notification settings - Fork 135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
RDoc-2883 OpenTelemetry #1862
RDoc-2883 OpenTelemetry #1862
Conversation
{ | ||
"Path": "prometheus.markdown", | ||
"Name": "Prometheus", | ||
"DiscussionId": "f59c124a-b94a-4380-bff2-dcb1782ef1f6", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same discussionId as in Telegraf? check with @reebhub if this is correct
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Danielle9897 can you take care of it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-
I have a fix for that
Will include the fix in the PR for:
https://issues.hibernatingrhinos.com/issue/RDoc-2944/Review-Open-Telemetry-documentation
(that PR will replace this one) -
The root cause is that the 'Monitoring' directory was not created correctly in the docs.json file in version 5.2.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@maciejaszyk just add @Danielle9897 as the collaborator to your repo so she'll be able to fix it here (no need to open another PR)
...tation/6.0/Raven.Documentation.Pages/server/administration/monitoring/opentelemetry.markdown
Outdated
Show resolved
Hide resolved
...tation/6.0/Raven.Documentation.Pages/server/administration/monitoring/opentelemetry.markdown
Outdated
Show resolved
Hide resolved
|
||
OpenTelemetry is a collection of APIs, SDKs, and tools. Use it to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) to help you analyze your software's performance and behavior. (description via [https://opentelemetry.io](https://opentelemetry.io)) | ||
|
||
RavenDB utilize official SDK and allows user to retrieve the metrics via OpenTelemetry protocol and much more! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
RavenDB utilize official SDK and allows user to retrieve the metrics via OpenTelemetry protocol and much more! | |
RavenDB utilizes the official OpenTelemetry SDK and allows user to retrieve the metrics via OpenTelemetry protocol and much more! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will be reviewing this article and fixing all phrasing/grammar issues in:
https://issues.hibernatingrhinos.com/issue/RDoc-2944/Review-Open-Telemetry-documentation
- [AspNetCore documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/src/OpenTelemetry.Instrumentation.AspNetCore/README.md#metrics) | ||
|
||
### Configuring meters | ||
By default, only most commonly used meters are turned on, but this can be controlled via following configuration options: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
By default, only most commonly used meters are turned on, but this can be controlled via following configuration options: | |
By default, only most commonly used meters are enabled. This can be controlled via following configuration options: |
| Monitoring.OpenTelemetry.Meters.AspNetCore.Enabled | Official AspNetCore instrumentation | false | | ||
| Monitoring.OpenTelemetry.Meters.Runtime.Enabled | Official Runtime instrumentation | false | | ||
| Monitoring.OpenTelemetry.Meters.Server.Storage.Enabled | ravendb.server.storage | true | | ||
| Monitoring.OpenTelemetry.Meters.Server.CPUCredits.Enabled | ravendb.server.cpucredits | false| |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we using CPU in all caps here? in the configuration it's spelled "Cpu" everywhere I remember
| Monitoring.OpenTelemetry.Meters.Server.Requests.Enabled | ravendb.server.requests | true | | ||
| Monitoring.OpenTelemetry.Meters.Server.GC.Enabled | ravendb.server.gc | false | | ||
|
||
### Meters instruments |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are we exposing information about the client certificates expiration?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No
| ravendb.server.totaldatabases.number_error_indexes | Number of error indexes in all loaded databases | UpDownCounter | | ||
| ravendb.server.totaldatabases.number_of_indexes | Number of indexes in all loaded databases | UpDownCounter | | ||
| ravendb.server.totaldatabases.number.faulty_indexes | Number of faulty indexes in all loaded databases | UpDownCounter | | ||
| ravendb.server.totaldatabases.writes_per_second | Number of writes \(documents, attachments, counters\) in all loaded databases | Gauge | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does it include time series writes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is from Snmp description, and it contains. Fix: ravendb/ravendb#19141
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So it should be reflected in the docs as well, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have added that in my latest docs PRs:
https://github.com/ravendb/docs/pull/1894/files
&
https://github.com/ravendb/docs/pull/1893/files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great. Thanks
...tation/6.0/Raven.Documentation.Pages/server/administration/monitoring/opentelemetry.markdown
Show resolved
Hide resolved
| ravendb.server.gc.compacted | Specifies if this is a compacting GC or not. | Gauge | | ||
| ravendb.server.gc.concurrent | Specifies if this is a concurrent GC or not. | Gauge | | ||
| ravendb.server.gc.finalizationpendingcount | Gets the number of objects ready for finalization this GC observed. | Gauge | | ||
| ravendb.server.gc.fragmented | Gets the total fragmentation (in MB) when the last garbage collection occurred. | Gauge | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does open telemetry suggests to use explicit units just like prometheus metrics?
See: https://prometheus.io/docs/practices/naming/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see it here: https://opentelemetry.io/docs/specs/semconv/general/metrics/
6.1 docs PR - #1883 Once the comments we have here will be addressed we can close this PR |
Please note that #1883 got already merged so fixes need to be applied as dedicated PR to |
Let me close it. YT issue is still open. |
https://issues.hibernatingrhinos.com/issue/RDoc-2883/Document-OpenTelemetry-integration