maint: add comments about an edge case in SendKey #1387
Merged
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
| @@ -155,6 +155,9 @@ A quick start for specific scenarios is below: | |||
| * Set `SendKey` to a valid Honeycomb Key | |||
| * Set `SendKeyMode` to `listedonly` | |||
|
|
|||
| +**NOTE** | |||
| + | |||
| +When using Beelines with a classic API key to send data to Refinery, ensure that the `SendKey` is also a classic Key, not an environment and service(E&S) key. | |||
There was a problem hiding this comment.
Would that work tho or would that header still get dropped? I think if you're sending with a Classic Key/Header combo that you should not use SendKey at all.
There was a problem hiding this comment.
If the SendKey is a classic key, it should work since the dataset header is present
MikeGoldsmith
approved these changes
Nov 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Which problem is this PR solving?
When using Beeline with a classic API key, events are sent with dataset configured. However, when Refinery replaces the API key with an E&S key, events are stored using service.name instead of dataset. Refinery cannot control Beeline’s dataset propagation, as this is handled by beeline configuration. This issue does not occur with OpenTelemetry (OTel) SDKs, which have a different propagation mechanism.
Short description of the changes