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

[chore][connector/servicegraph][processor/servicegraph] Cleanup and copy configuration README #29919

Merged
merged 2 commits into from
Jan 10, 2024

Conversation

crobert-1
Copy link
Member

Documentation:
#27879 recently added a new configuration option to the servicegraph components called metrics_flush_interval. I noticed this wasn't documented for either component, and the connector/servicegraph README doesn't include a configuration section. Since the connector is just a wrapper of the processor at this point, I cleaned up the processor's configuration section and copied it to the connector, adding an entry for the new metrics_flush_interval option.

@@ -117,15 +117,16 @@ The following settings are required:

The following settings can be optionally configured:

- `store` defines the config for the in-memory store used to find requests between services by pairing spans.
Copy link
Member Author

Choose a reason for hiding this comment

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

I was thinking of removing the entire contents of the processor's configuration section and directly linking to the connector's section, so we don't have a copy of information that we have to maintain. My concern though is there's a possibility of adding connector-specific options at some point, and also since the processor is deprecated maintaining these duplicates may not be a long term issue.

Happy to use a link instead though if others think that's preferable.

@crobert-1 crobert-1 added the documentation Improvements or additions to documentation label Dec 15, 2023
Copy link
Contributor

@bryan-aguilar bryan-aguilar left a comment

Choose a reason for hiding this comment

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

Can we add defaults for all options to be consistent?

connector/servicegraphconnector/README.md Outdated Show resolved Hide resolved
connector/servicegraphconnector/README.md Outdated Show resolved Hide resolved
- Add defaults
- Fix indentation
@bryan-aguilar bryan-aguilar added the ready to merge Code review completed; ready to merge by maintainers label Jan 3, 2024
@bogdandrutu bogdandrutu merged commit 178e315 into open-telemetry:main Jan 10, 2024
90 checks passed
@github-actions github-actions bot added this to the next release milestone Jan 10, 2024
cparkins pushed a commit to AmadeusITGroup/opentelemetry-collector-contrib that referenced this pull request Jan 10, 2024
…opy configuration README (open-telemetry#29919)

**Documentation:** <Describe the documentation added.>
open-telemetry#27879 recently added a new configuration option to the `servicegraph`
components called `metrics_flush_interval`. I noticed this wasn't
documented for either component, and the `connector/servicegraph` README
doesn't include a configuration section. Since the connector is just a
wrapper of the processor at this point, I cleaned up the processor's
configuration section and copied it to the connector, adding an entry
for the new `metrics_flush_interval` option.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
connector/servicegraph documentation Improvements or additions to documentation processor/servicegraph Service graph processor ready to merge Code review completed; ready to merge by maintainers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants