[chore][connector/servicegraph][processor/servicegraph] Cleanup and copy configuration README #29919
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
connector/servicegraph
processor/servicegraph
crobert-1
commented
Dec 15, 2023
| @@ -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. | |||
There was a problem hiding this comment.
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
force-pushed
the
servicegraph_readme
branch
from
6a7b412 to
5cbe9af
Compare
- Add defaults - Fix indentation
bryan-aguilar
approved these changes
Jan 3, 2024
bryan-aguilar
added
the
ready to merge
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.
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation:
#27879 recently added a new configuration option to the
servicegraphcomponents calledmetrics_flush_interval. I noticed this wasn't documented for either component, and theconnector/servicegraphREADME 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 newmetrics_flush_intervaloption.