-
Notifications
You must be signed in to change notification settings - Fork 4
docs: clarify metrics not included in Coralogix integration #157
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
base: main
Are you sure you want to change the base?
Conversation
Add 'What's included' section listing traces, HTTP instrumentation, and correlation metadata. Add note clarifying that metrics are not included and linking to Prometheus integration for metrics export.
guolau
left a comment
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.
Thanks Thomas! Good thing to clarify for this integration. I left a few small nits 🙂
| If you are using a different trace header than the standard `traceparent`, you can configure this header in the *custom | ||
| trace header* field in the integration settings. |
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.
Should this line be moved to above the "What's included" section (to line 57)? Seems like it's separated from the relevant section currently
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 still needs to be moved up, I think?
| Using these tags, you can create filters, dashboards and slice & dice your Checkly data as your runs are executed and | ||
| ingested into Coralogix as traces. | ||
|
|
||
| ### What's included |
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.
Should this content be at the beginning of the "Open Telemetry tracing integration" section?
It seems like we're just summarizing what the Coralogix OTel integration includes. I feel like it makes more sense to have this at the beginning of the section (so users can skim and see what's included) rather than at the end?
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.
The idea is to make sure customer understand what level f integration he will get from default CX integration
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.
Fair enough 🙂 I still think it would be better at the start of this section, but not a strong preference either way. Feel free to resolve this comment.
Make sens to keep names closer to what we have Co-authored-by: Laura Guo <48332483+guolau@users.noreply.github.com>
| If you are using a different trace header than the standard `traceparent`, you can configure this header in the *custom | ||
| trace header* field in the integration settings. |
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 still needs to be moved up, I think?
| Using these tags, you can create filters, dashboards and slice & dice your Checkly data as your runs are executed and | ||
| ingested into Coralogix as traces. | ||
|
|
||
| ### What's included |
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.
Fair enough 🙂 I still think it would be better at the start of this section, but not a strong preference either way. Feel free to resolve this comment.
Added a "What's included" section to clarify that the Coralogix OTEL integration only sends traces, not metrics.
Users who want metrics in Coralogix can use the Prometheus integration + OTEL Collector.