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

Add comments for debug and logging exporter #3768

Closed
wants to merge 4 commits into from

Conversation

theletterf
Copy link
Contributor

Follows #3755

@theletterf theletterf requested review from a team as code owners October 13, 2023 09:40
@theletterf theletterf self-assigned this Oct 13, 2023
@theletterf theletterf added the documentation Improvements or additions to documentation label Oct 13, 2023
theletterf and others added 2 commits October 13, 2023 15:41
Co-authored-by: Ryan Fitzpatrick <10867373+rmfitzpatrick@users.noreply.github.com>
Co-authored-by: Ryan Fitzpatrick <10867373+rmfitzpatrick@users.noreply.github.com>
@theletterf
Copy link
Contributor Author

@rmfitzpatrick I only edited comments and now a couple integration tests are failing? How so?

@rmfitzpatrick
Copy link
Contributor

@rmfitzpatrick I only edited comments and now a couple integration tests are failing? How so?

The test failures are expected since the agent config has been changed. This is what the test is for since changes to this config are meaningful for users. You can update the expected value to reflect the contents at the path detailed in the failure.

Co-authored-by: Jeff Cheng <83052155+jeffreyc-splunk@users.noreply.github.com>
@theletterf
Copy link
Contributor Author

We haven't reverted the other PR yet. What's the decision here, @atoulme ?

@rmfitzpatrick
Copy link
Contributor

We haven't reverted the other PR yet. What's the decision here, @atoulme ?

If you update the debug references to logging in the agent and gateway configs, I don't think reverting is required.

@@ -156,7 +156,8 @@ exporters:
endpoint: "${SPLUNK_GATEWAY_URL}:4317"
tls:
insecure: true
# Debug
# This component has been deprecated by the "debug" exporter,
Copy link
Contributor

Choose a reason for hiding this comment

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

This comment only makes sense in the context of a logging exporter.

@theletterf
Copy link
Contributor Author

@rmfitzpatrick @jeffreyc-splunk TBH, I'm a bit confused right now as to what I should change for this to go through. Ryan, you seem to suggest a partial revert of some config files: could you apply the relevant code suggestions? I feel like I'm cutting red wire from a detonator right now... :-)

@jeffreyc-splunk
Copy link
Contributor

@rmfitzpatrick @jeffreyc-splunk TBH, I'm a bit confused right now as to what I should change for this to go through. Ryan, you seem to suggest a partial revert of some config files: could you apply the relevant code suggestions? I feel like I'm cutting red wire from a detonator right now... :-)

If we're not reverting the previous changes, I think the test failures would be resolved by rebasing the branch with main.

@atoulme
Copy link
Contributor

atoulme commented Oct 17, 2023

I would like us to be forward looking and adopt the latest, document that previous versions use the previous approach. We can discuss in team meeting and weigh pros and cons a bit more.

@theletterf theletterf closed this Mar 1, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Mar 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants