-
Notifications
You must be signed in to change notification settings - Fork 97
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
Monitoring main documentation #3050
base: master
Are you sure you want to change the base?
Conversation
Update monitoring.md
Update spryker-monitoring-integration.md
removed duplicated text
…tion Added overview of OTEL
added details of OTel integration
added md extension
added md extension
minor changes
minor changes
changed page structure, added missing info
content added to the how to instrument page
content added in the main SMI overview
## Telemetry data in scope of Spryker Monitoring Integration | ||
The Spryker Monitoring Integration focuses on several key entities to provide comprehensive monitoring: | ||
|
||
### Traces and Spans |
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.
it is already explained in How to Instrument shall we link to this section?
The default metrics resolution is 60 seconds. All metrics can be split by telemetry-data-account. | ||
|
||
## How do I get it? | ||
### Prerequisites |
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.
shall we mention also commercials have to be signed before?
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.
@romansprykee yes, let's mentioned that as soon as the agreement for this SKU is concluded.
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.
All good from my side
The Spryker Monitoring Integration focuses on several key entities to provide comprehensive monitoring: | ||
|
||
### Traces and Spans | ||
In OpenTelemetry, a **trace** represents the journey of a single request or transaction as it moves through various components of a system, capturing the end-to-end flow. A **span** is a single operation or unit of work within a trace, containing information like the operation name, start and end times, and any relevant metadata. Together, traces and spans provide a detailed view of the interactions and performance of different parts of an application, helping to diagnose issues and optimize performance. |
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.
@gechetspr let's add here the supported version of OTEL convention - 1.30. As a highlighted box.
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.
Please take a look at minor comments, after those additions let's publish.
PR labels
When the PR is ready for review, add a TW review needed label. This lets us keep track of PRs that need to be merged and merge them in time.
PR Description
Describe the context for your changes and the changes you've made.
Tickets
If changes are associated with a ticket, add a docs ticket here.
Checklist