Skip to content

[exporter/datasetexporter] Documentation does not contains all the options #27649

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.

Sign up for GitHub

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

Jump to bottom
Closed
martin-majlis-s1 opened this issue Oct 12, 2023 · 2 comments · Fixed by #27683
Closed

[exporter/datasetexporter] Documentation does not contains all the options #27649

martin-majlis-s1 opened this issue Oct 12, 2023 · 2 comments · Fixed by #27683
Labels
documentation Improvements or additions to documentation exporter/dataset

Comments

@martin-majlis-s1
Copy link
Contributor

Component(s)

exporter/dataset

What happened?

Description

For example configuration option - logs.export_resource_info_on_event is missing in the documentation.

Steps to Reproduce

The configuration exists - https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/datasetexporter/config.go#L36C41-L36C70 - and is used - https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/datasetexporter/logs_exporter.go#L214 - but it's not mentioned in the https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/datasetexporter/README.md.

Expected Result

All the configuration options are mentioned in the README.

Actual Result

Some of them are missing

Collector version

v0.85.0

Environment information

Environment

OS: (e.g., "Ubuntu 20.04")
Compiler(if manually compiled): (e.g., "go 14.2")

OpenTelemetry Collector configuration

No response

Log output

No response

Additional context

No response
@martin-majlis-s1 martin-majlis-s1 added bug Something isn't working needs triage New item requiring triage labels Oct 12, 2023
@github-actions
Copy link
Contributor

Pinging code owners for exporter/dataset: @atoulme @martin-majlis-s1 @zdaratom @tomaz-s1. See Adding Labels via Comments if you do not have permissions to add labels yourself.

@crobert-1 crobert-1 added documentation Improvements or additions to documentation and removed bug Something isn't working labels Oct 12, 2023
@crobert-1
Copy link
Member

Removing needs triage as a code owner filed this issue, and the enhancement makes sense to me.

@crobert-1 crobert-1 removed the needs triage New item requiring triage label Oct 12, 2023
@martin-majlis-s1 martin-majlis-s1 mentioned this issue Oct 16, 2023
Merged
@github-actions github-actions bot mentioned this issue Oct 17, 2023
Closed
mx-psi added a commit that referenced this issue Oct 20, 2023
@martin-majlis-s1 @tpaschalis
@jpkrohling @dmitryax @andrzej-stencel @hovavza @djaglowski @BinaryFissionGames @mdonkers @bryan-aguilar @sakulali @c-kruse @gord02 @bagmeg @songy23 @mx-psi @TylerHelmuth @opentelemetrybot @crobert-1 @VihasMakwana @atoulme
[exporter/datasetexporter]: Make export of resources and scopes more …
e347ff3 
…flexible (#27683)

**Description:** Make export of resources and scopes more flexible

**Link to tracking Issue:** #27651 , #27649 

**Testing:** Unit tests

**Documentation:** <Describe the documentation added.>

**Note:**: This PR is on top of this PR -
https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/27663/files
- since it's introducing some helper functions and it's fixing NPE.

Fixes #27651
Fixes #27649

---------

Signed-off-by: Paschalis Tsilias <[email protected]>
Signed-off-by: Christian Kruse <[email protected]>
Co-authored-by: Paschalis Tsilias <[email protected]>
Co-authored-by: Juraci Paixão Kröhling <[email protected]>
Co-authored-by: Dmitrii Anoshin <[email protected]>
Co-authored-by: Andrzej Stencel <[email protected]>
Co-authored-by: hovavza <[email protected]>
Co-authored-by: Daniel Jaglowski <[email protected]>
Co-authored-by: Brandon Johnson <[email protected]>
Co-authored-by: Miel Donkers <[email protected]>
Co-authored-by: bryan-aguilar <[email protected]>
Co-authored-by: sakulali <[email protected]>
Co-authored-by: Christian Kruse <[email protected]>
Co-authored-by: gord02 <[email protected]>
Co-authored-by: bagmeg <[email protected]>
Co-authored-by: Yang Song <[email protected]>
Co-authored-by: Pablo Baeyens <[email protected]>
Co-authored-by: Tyler Helmuth <[email protected]>
Co-authored-by: OpenTelemetry Bot <[email protected]>
Co-authored-by: Curtis Robert <[email protected]>
Co-authored-by: VihasMakwana <[email protected]>
Co-authored-by: Antoine Toulme <[email protected]>
sigilioso pushed a commit to carlossscastro/opentelemetry-collector-contrib that referenced this issue Oct 27, 2023
@martin-majlis-s1 @tpaschalis
@jpkrohling @dmitryax @andrzej-stencel @hovavza @djaglowski @BinaryFissionGames @mdonkers @bryan-aguilar @sakulali @c-kruse @gord02 @bagmeg @songy23 @mx-psi @TylerHelmuth @opentelemetrybot @crobert-1 @VihasMakwana @atoulme @sigilioso
[exporter/datasetexporter]: Make export of resources and scopes more …
7ae7c3b 
…flexible (open-telemetry#27683)

**Description:** Make export of resources and scopes more flexible

**Link to tracking Issue:** open-telemetry#27651 , open-telemetry#27649 

**Testing:** Unit tests

**Documentation:** <Describe the documentation added.>

**Note:**: This PR is on top of this PR -
https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/27663/files
- since it's introducing some helper functions and it's fixing NPE.

Fixes open-telemetry#27651
Fixes open-telemetry#27649

---------

Signed-off-by: Paschalis Tsilias <[email protected]>
Signed-off-by: Christian Kruse <[email protected]>
Co-authored-by: Paschalis Tsilias <[email protected]>
Co-authored-by: Juraci Paixão Kröhling <[email protected]>
Co-authored-by: Dmitrii Anoshin <[email protected]>
Co-authored-by: Andrzej Stencel <[email protected]>
Co-authored-by: hovavza <[email protected]>
Co-authored-by: Daniel Jaglowski <[email protected]>
Co-authored-by: Brandon Johnson <[email protected]>
Co-authored-by: Miel Donkers <[email protected]>
Co-authored-by: bryan-aguilar <[email protected]>
Co-authored-by: sakulali <[email protected]>
Co-authored-by: Christian Kruse <[email protected]>
Co-authored-by: gord02 <[email protected]>
Co-authored-by: bagmeg <[email protected]>
Co-authored-by: Yang Song <[email protected]>
Co-authored-by: Pablo Baeyens <[email protected]>
Co-authored-by: Tyler Helmuth <[email protected]>
Co-authored-by: OpenTelemetry Bot <[email protected]>
Co-authored-by: Curtis Robert <[email protected]>
Co-authored-by: VihasMakwana <[email protected]>
Co-authored-by: Antoine Toulme <[email protected]>
jmsnll pushed a commit to jmsnll/opentelemetry-collector-contrib that referenced this issue Nov 12, 2023
@martin-majlis-s1 @tpaschalis
@jpkrohling @dmitryax @andrzej-stencel @hovavza @djaglowski @BinaryFissionGames @mdonkers @bryan-aguilar @sakulali @c-kruse @gord02 @bagmeg @songy23 @mx-psi @TylerHelmuth @opentelemetrybot @crobert-1 @VihasMakwana @atoulme @jmsnll
[exporter/datasetexporter]: Make export of resources and scopes more …
0ba990e 
…flexible (open-telemetry#27683)

**Description:** Make export of resources and scopes more flexible

**Link to tracking Issue:** open-telemetry#27651 , open-telemetry#27649 

**Testing:** Unit tests

**Documentation:** <Describe the documentation added.>

**Note:**: This PR is on top of this PR -
https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/27663/files
- since it's introducing some helper functions and it's fixing NPE.

Fixes open-telemetry#27651
Fixes open-telemetry#27649

---------

Signed-off-by: Paschalis Tsilias <[email protected]>
Signed-off-by: Christian Kruse <[email protected]>
Co-authored-by: Paschalis Tsilias <[email protected]>
Co-authored-by: Juraci Paixão Kröhling <[email protected]>
Co-authored-by: Dmitrii Anoshin <[email protected]>
Co-authored-by: Andrzej Stencel <[email protected]>
Co-authored-by: hovavza <[email protected]>
Co-authored-by: Daniel Jaglowski <[email protected]>
Co-authored-by: Brandon Johnson <[email protected]>
Co-authored-by: Miel Donkers <[email protected]>
Co-authored-by: bryan-aguilar <[email protected]>
Co-authored-by: sakulali <[email protected]>
Co-authored-by: Christian Kruse <[email protected]>
Co-authored-by: gord02 <[email protected]>
Co-authored-by: bagmeg <[email protected]>
Co-authored-by: Yang Song <[email protected]>
Co-authored-by: Pablo Baeyens <[email protected]>
Co-authored-by: Tyler Helmuth <[email protected]>
Co-authored-by: OpenTelemetry Bot <[email protected]>
Co-authored-by: Curtis Robert <[email protected]>
Co-authored-by: VihasMakwana <[email protected]>
Co-authored-by: Antoine Toulme <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation exporter/dataset
Projects
None yet
Milestone
No milestone
2 participants
@crobert-1 @martin-majlis-s1