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

[azure-eventhub] Make the azure-eventhub input v1 tracer opt-in #41932

Merged
merged 4 commits into from
Dec 6, 2024

Conversation

zmoog
Copy link
Contributor

@zmoog zmoog commented Dec 6, 2024

Proposed commit message

Make the azure-eventhub input v1 internal logs tracer opt-in. To enable internal (legacy) Event Hub SDK logs, now you need to set the following environment variable:

BEATS_AZURE_EVENTHUB_INPUT_TRACING_ENABLED: true

Before this change, the tracer was enabled by default.

A few customers reported higher than anticipated error logs in edge cases. These error logs are an essential signal to troubleshoot the root cause of several issues. However, we should give the option to completely opt out from the internal logs tracing when needed.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Disruptive User Impact

Author's Checklist

  • Write a KB article that describes how to enable and what you get
  • Add the environment variable to the input docs

How to test this PR locally

Related issues

@zmoog zmoog added enhancement Team:obs-ds-hosted-services Label for the Observability Hosted Services team input:azure-eventhub labels Dec 6, 2024
@zmoog zmoog self-assigned this Dec 6, 2024
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Dec 6, 2024
Copy link
Contributor

mergify bot commented Dec 6, 2024

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @zmoog? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit

Copy link
Contributor

mergify bot commented Dec 6, 2024

backport-8.x has been added to help with the transition to the new branch 8.x.
If you don't need it please use backport-skip label and remove the backport-8.x label.

@mergify mergify bot added the backport-8.x Automated backport to the 8.x branch with mergify label Dec 6, 2024
@zmoog zmoog marked this pull request as ready for review December 6, 2024 14:31
@zmoog zmoog requested a review from a team as a code owner December 6, 2024 14:31
@elasticmachine
Copy link
Collaborator

Pinging @elastic/obs-ds-hosted-services (Team:obs-ds-hosted-services)

Copy link
Contributor

@tetianakravchenko tetianakravchenko left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -356,6 +356,7 @@ https://github.com/elastic/beats/compare/v8.8.1\...main[Check the HEAD diff]
- Add evaluation state dump debugging option to CEL input. {pull}41335[41335]
- Added support for retry configuration in GCS input. {issue}11580[11580] {pull}41862[41862]
- Improve S3 polling mode states registry when using list prefix option. {pull}41869[41869]
- The environment variable `BEATS_AZURE_EVENTHUB_INPUT_TRACING_ENABLED: true` enables internal logs tracer for the azure-eventhub input. {issue}41931[41931] {pull}41932[41932]
Copy link
Contributor

Choose a reason for hiding this comment

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

should this variable be added to public documentation?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why I didn't think of it?! 🤦

Added!

@zmoog zmoog added backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify labels Dec 6, 2024
Copy link
Contributor

mergify bot commented Dec 6, 2024

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b zmoog/azure-eventhub-input-make-internal-logs-optional upstream/zmoog/azure-eventhub-input-make-internal-logs-optional
git merge upstream/main
git push upstream zmoog/azure-eventhub-input-make-internal-logs-optional

@zmoog zmoog enabled auto-merge (squash) December 6, 2024 18:53
@zmoog zmoog merged commit 3b5823f into main Dec 6, 2024
22 checks passed
@zmoog zmoog deleted the zmoog/azure-eventhub-input-make-internal-logs-optional branch December 6, 2024 19:22
mergify bot pushed a commit that referenced this pull request Dec 6, 2024
Make the `azure-eventhub` input v1 internal logs tracer opt-in. To enable internal (legacy) Event Hub SDK logs, now you need to set the following environment variable:

```sh
BEATS_AZURE_EVENTHUB_INPUT_TRACING_ENABLED: true
```

Before this change, the tracer was enabled by default.

A few customers reported higher than anticipated error logs in edge cases. These error logs are an essential signal to troubleshoot the root cause of several issues. However, we should give the option to completely opt out from the internal logs tracing when needed.

(cherry picked from commit 3b5823f)
mergify bot pushed a commit that referenced this pull request Dec 6, 2024
Make the `azure-eventhub` input v1 internal logs tracer opt-in. To enable internal (legacy) Event Hub SDK logs, now you need to set the following environment variable:

```sh
BEATS_AZURE_EVENTHUB_INPUT_TRACING_ENABLED: true
```

Before this change, the tracer was enabled by default.

A few customers reported higher than anticipated error logs in edge cases. These error logs are an essential signal to troubleshoot the root cause of several issues. However, we should give the option to completely opt out from the internal logs tracing when needed.

(cherry picked from commit 3b5823f)
mergify bot pushed a commit that referenced this pull request Dec 6, 2024
Make the `azure-eventhub` input v1 internal logs tracer opt-in. To enable internal (legacy) Event Hub SDK logs, now you need to set the following environment variable:

```sh
BEATS_AZURE_EVENTHUB_INPUT_TRACING_ENABLED: true
```

Before this change, the tracer was enabled by default.

A few customers reported higher than anticipated error logs in edge cases. These error logs are an essential signal to troubleshoot the root cause of several issues. However, we should give the option to completely opt out from the internal logs tracing when needed.

(cherry picked from commit 3b5823f)
zmoog added a commit that referenced this pull request Dec 6, 2024
…) (#41942)

Make the `azure-eventhub` input v1 internal logs tracer opt-in. To enable internal (legacy) Event Hub SDK logs, now you need to set the following environment variable:

```sh
BEATS_AZURE_EVENTHUB_INPUT_TRACING_ENABLED: true
```

Before this change, the tracer was enabled by default.

A few customers reported higher than anticipated error logs in edge cases. These error logs are an essential signal to troubleshoot the root cause of several issues. However, we should give the option to completely opt out from the internal logs tracing when needed.

(cherry picked from commit 3b5823f)

Co-authored-by: Maurizio Branca <maurizio.branca@elastic.co>
zmoog added a commit that referenced this pull request Dec 6, 2024
…) (#41943)

Make the `azure-eventhub` input v1 internal logs tracer opt-in. To enable internal (legacy) Event Hub SDK logs, now you need to set the following environment variable:

```sh
BEATS_AZURE_EVENTHUB_INPUT_TRACING_ENABLED: true
```

Before this change, the tracer was enabled by default.

A few customers reported higher than anticipated error logs in edge cases. These error logs are an essential signal to troubleshoot the root cause of several issues. However, we should give the option to completely opt out from the internal logs tracing when needed.

(cherry picked from commit 3b5823f)

Co-authored-by: Maurizio Branca <maurizio.branca@elastic.co>
zmoog added a commit that referenced this pull request Dec 6, 2024
…) (#41941)

Make the `azure-eventhub` input v1 internal logs tracer opt-in. To enable internal (legacy) Event Hub SDK logs, now you need to set the following environment variable:

```sh
BEATS_AZURE_EVENTHUB_INPUT_TRACING_ENABLED: true
```

Before this change, the tracer was enabled by default.

A few customers reported higher than anticipated error logs in edge cases. These error logs are an essential signal to troubleshoot the root cause of several issues. However, we should give the option to completely opt out from the internal logs tracing when needed.

(cherry picked from commit 3b5823f)

Co-authored-by: Maurizio Branca <maurizio.branca@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify enhancement input:azure-eventhub Team:obs-ds-hosted-services Label for the Observability Hosted Services team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[azure-eventhub] Change input v1 tracing configuration to opt-in
4 participants