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

Update EUM-Server exporter documentation #1569

Conversation

heiko-holz
Copy link
Contributor

@heiko-holz heiko-holz commented Jan 25, 2023

Closes #1549

As part of inspectIT/inspectit-ocelot-eum-server#12, this PR updates the documentation of the tracing and metrics exporter of the EUM.


This change is Reviewable

@heiko-holz heiko-holz marked this pull request as ready for review January 25, 2023 09:53
Copy link
Contributor Author

@heiko-holz heiko-holz left a comment

Choose a reason for hiding this comment

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

Reviewable status: 0 of 2 files reviewed, 1 unresolved discussion (waiting on @PDuwe)


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md line 483 at r1 (raw file):

Previously, PDuwe wrote…

Maybe I misunderstood something, but you say earlier that by default prometheus exporter is disabled (l. 474)
This however suggests, that it is enabled. Or am I mistaken? :)

Hey,
yes the Prometheus exporter is disabled by default.
The snippet shows how to enable it (written in lines above The following configuration snippet shows the default configuration of the prometheus-exporter, exposing on port 8888:)

Dimi-Ma
Dimi-Ma previously approved these changes Jan 25, 2023
Copy link
Member

@Dimi-Ma Dimi-Ma left a comment

Choose a reason for hiding this comment

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

Reviewed 2 of 2 files at r1, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @PDuwe)


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md line 483 at r1 (raw file):

Previously, heiko-holz (Heiko Holz) wrote…

Hey,
yes the Prometheus exporter is disabled by default.
The snippet shows how to enable it (written in lines above The following configuration snippet shows the default configuration of the prometheus-exporter, exposing on port 8888:)

It might lead to misunderstandings if you say that this snippet shows the default configuration of the prometheus-exporter with it being enabled but say that it is disabled by default.

Copy link
Contributor Author

@heiko-holz heiko-holz left a comment

Choose a reason for hiding this comment

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

Reviewable status: 1 of 2 files reviewed, 1 unresolved discussion (waiting on @Dimi-Ma and @PDuwe)


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md line 483 at r1 (raw file):

Previously, Dimi-Ma (Dimitiros Mantas) wrote…

It might lead to misunderstandings if you say that this snippet shows the default configuration of the prometheus-exporter with it being enabled but say that it is disabled by default.

I agree.
this was a sentence "from the past", when Prometheus was enabled by default. I have adjusted it accordingly.

Thanks for catching this!

Copy link
Member

@Dimi-Ma Dimi-Ma left a comment

Choose a reason for hiding this comment

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

Dismissed @PDuwe from a discussion.
Reviewable status: 1 of 2 files reviewed, 1 unresolved discussion (waiting on @heiko-holz)


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md line 476 at r2 (raw file):

By default, the prometheus exporter is disabled.

The following configuration snippet shows makes the prometheus-exporter exposing the metrics on port `8888`:

This sentence feels wrong 🤔 I would change it to: "The following configuration snippet shows how the prometheus-exporter exposes the metrics on port 8888:"

@heiko-holz heiko-holz force-pushed the features/feat-eum-12-update-eum-exporter-documentation branch from 96a8a0d to ffaf085 Compare January 25, 2023 10:34
Copy link
Contributor Author

@heiko-holz heiko-holz left a comment

Choose a reason for hiding this comment

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

Reviewable status: 1 of 2 files reviewed, 1 unresolved discussion (waiting on @Dimi-Ma)


inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md line 476 at r2 (raw file):

Previously, Dimi-Ma (Dimitiros Mantas) wrote…

This sentence feels wrong 🤔 I would change it to: "The following configuration snippet shows how the prometheus-exporter exposes the metrics on port 8888:"

Yes, it was indeed grammatically wrong. I changed it.

Copy link
Member

@Dimi-Ma Dimi-Ma left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 1 of 1 files at r2, 1 of 1 files at r3, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @heiko-holz)

@heiko-holz heiko-holz merged commit d206454 into inspectIT:master Jan 25, 2023
@heiko-holz heiko-holz deleted the features/feat-eum-12-update-eum-exporter-documentation branch January 25, 2023 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] - Update the EUM documentation according to latest EUM release
2 participants