Skip to content
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

Exporter metrics with Micrometer #4082

Merged
merged 3 commits into from
Aug 2, 2024
Merged

Exporter metrics with Micrometer #4082

merged 3 commits into from
Aug 2, 2024

Conversation

EuroLew
Copy link
Contributor

@EuroLew EuroLew commented Jul 30, 2024

Description

Tells the user how to aadd metrics to their exporter and notes a potential pitfall about interacting with a to be discarded registry.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@EuroLew EuroLew requested a review from npepinpe July 30, 2024 15:45
Copy link
Contributor

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.5/.

  • docs/self-managed/concepts/exporters.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@christinaausley christinaausley added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Jul 30, 2024
@akeller akeller requested a review from a team July 30, 2024 21:18
@christinaausley
Copy link
Contributor

Is this relevant to the current 8.5 docs as well? If so, I can backport.

@EuroLew
Copy link
Contributor Author

EuroLew commented Jul 31, 2024

Is this relevant to the current 8.5 docs as well? If so, I can backport.

No it is not it will be in 8.6

@EuroLew EuroLew merged commit 16c7afa into main Aug 2, 2024
7 checks passed
@EuroLew EuroLew deleted the el-18467-exporter-metrics branch August 2, 2024 09:28
@@ -64,6 +64,12 @@ validation of their configuration (e.g. fail if missing arguments). For this val
One caveat is that an instance of an exporter is created and immediately thrown away. Therefore, exporters should not perform any computationally
heavy work during instantiation/configuration.

### Metrics

The exporter is provided with a Micrometer [MeterRegistry](https://docs.micrometer.io/micrometer/reference/concepts/registry.html) in the `Exporter#configure(Configuration)` method through the configuration. Any metrics to be exported should interact with the registry.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❌ This is actually Exporter#configure(Context) 🙃

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll launch a PR with this fix 👍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christinaausley christinaausley mentioned this pull request Aug 2, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants