[chore] Spelling exporter #37133
Open
[chore] Spelling exporter #37133
+275
−285
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
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
github-actions
bot
added
exporter/loadbalancing
exporter/logzio
exporter/loki
crobert-1
reviewed
Jan 10, 2025
There was a problem hiding this comment.
Thanks for the PR, really appreciate all of the fixes!
Note: One thing that concerns me is when metric or attributes names are changed to fix typos as it may break existing functionality, but in this PR it looks like it's all test code, where a test is writing and then checking a typo. I think this PR is fine on that front.
| @@ -103,7 +103,7 @@ The exporter follows the semantic conventions to fill the Application Insights s | |||
| | Dependency.ResultCode | `http.status_code` or `status_code` | `"0"` | | |||
| | Dependency.Success | `http.status_code` or `status_code` | `true` | | |||
|
|
|||
| The exact mapping can be found [here](trace_to_envelope.go). | |||
| The exact mapping can be found in [trace_to_envelope.go](trace_to_envelope.go). | |||
There was a problem hiding this comment.
I see a few places where here is replaced with the filename, or something more specific. Is this a known best practice? I'm not opposed, just curious.
There was a problem hiding this comment.
Yes (fwiw the check-spelling report is buried a few layers back, but here's the excerpt):
Do not use (click) here links
For more information, see:
- https://www.w3.org/QA/Tips/noClickHere
- https://webaim.org/techniques/hypertext/link_text
- https://granicus.com/blog/why-click-here-links-are-bad/
- https://heyoka.medium.com/dont-use-click-here-f32f445d1021
(?i)(?:>|\[)(?:(?:click |)here|link|(?:read |)more)(?:</|\]\()
| In addition, this exporter offers queued retry which is enabled by default. | ||
| Information about queued retry configuration parameters can be found | ||
| [here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md). | ||
| In addition, this [exporter](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md) offers queued retry which is enabled by default. |
There was a problem hiding this comment.
Suggested change
| In addition, this [exporter](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md) offers queued retry which is enabled by default. | |
| In addition, this exporter offers [queued retry](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md) which is enabled by default. |
The link here is to show documentation on queued retry options, not the exporter itself.
There was a problem hiding this comment.
I struggled a lot w/ this specific item -- ideally a link should describe what's on the other side of the link -- if the link was https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md#queued-retry, then queued retry would be a proper link.
It's better to say "see the queued retry options in the exporter documentation" or something like that...
| - `batcher`(Experimental, disabled by default): Specifies batching configuration on the exporter. Information about the configuration can be found [here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md) | ||
| - `batcher`(Experimental, disabled by default): Specifies [batching configuration on the exporter](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md). | ||
|
|
||
| In addition, this [exporter](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md) offers queued retry which is enabled by default. |
There was a problem hiding this comment.
Suggested change
| In addition, this [exporter](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md) offers queued retry which is enabled by default. | |
| In addition, this exporter offers [queued retry](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md) which is enabled by default. |
Same as other comment, the link is to help with queued retry options, not the exporter itself.
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
naming.md Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
Signed-off-by: Josh Soref <[email protected]>
jsoref
force-pushed
the
spelling-exporter
branch
from
f1a5b49 to
e0aa04c
Compare
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.
Description
Fix spelling in exporter/
#37128 (review)
Link to tracking issue