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.

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

Add status header to all components #10116

Closed
codeboten opened this issue May 17, 2022 · 15 comments · Fixed by #11071
Closed

Add status header to all components #10116

codeboten opened this issue May 17, 2022 · 15 comments · Fixed by #11071
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed priority:p3 Lowest

Comments

@codeboten
Copy link
Contributor

codeboten commented May 17, 2022 •
edited by atoulme
Loading

In an effort to make finding the state of each component easier, the README for each component should contain a table which includes:

  • stability level (should be one of: in development, alpha, beta, stable or deprecated)
  • supported pipelines
  • distributions which contain the component (can be none or any combination of: core, contrib). Additionally, if other distributions include these components, they can be listed here.

See #10006 for an example table with embedded links:

| Status                   |           |
| ------------------------ | --------- |
| Stability                | [beta]    |
| Supported pipeline types | traces    |
| Distributions            | [contrib] |

<README contents>

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

NOTE: For extensions, please remove the Supported pipeline types as it does not apply.

Exporters

Extensions

Processors

Receivers
@codeboten codeboten added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels May 17, 2022
@TylerHelmuth
Copy link
Member

#10002 is open for transformprocessor

@TylerHelmuth TylerHelmuth mentioned this issue May 18, 2022
Merged
@codeboten codeboten added the priority:p3 Lowest label May 18, 2022
@pmm-sumo
Copy link
Contributor

pmm-sumo commented May 19, 2022 •
edited
Loading

The template in the issue description seems to have a mistake. It says:

[beta]: https://github.com/open-telemetry/opentelemetry-collector-contrib#beta

It should be:

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta

It seems that some of the headers already use the former. Are we going to add stability levels to contrib readme or should those be fixed?

@TylerHelmuth
Copy link
Member

@codeboten several PRs have been opened with the -contrib link, can you update the issue's description?

@codeboten
Copy link
Contributor Author

@TylerHelmuth good point, updated 👍

@djaglowski djaglowski mentioned this issue May 23, 2022
Merged
This was referenced May 24, 2022
Closed
Merged
@Frapschen
Copy link
Contributor

miss the mezmoexporter?

@Frapschen
Copy link
Contributor

I have created PRs for all exporter components, pls review :)

This was referenced May 25, 2022
Merged
Merged
Merged
@TylerHelmuth TylerHelmuth mentioned this issue May 25, 2022
Merged
@jkowall
Copy link
Contributor

jkowall commented May 26, 2022

What are the options for the “stability” header? What are the options for the "distribution" header?

Thanks!

@codeboten
Copy link
Contributor Author

@jkowall I updated the description, please take a look

@JaredTan95 JaredTan95 mentioned this issue May 31, 2022
Merged
@my-git9 my-git9 mentioned this issue Jun 16, 2022
Merged
This was referenced Jun 17, 2022
Merged
Closed
@codeboten codeboten reopened this Jun 17, 2022
djaglowski added a commit that referenced this issue Jun 17, 2022
@antonblock @djaglowski
[receiver/aerospikereceiver] New Aerospike metrics receiver (#9961)
c7fa006 
* WIP: Aerospike metrics receiver

- Add initial receiver
- Needs more tests
- Needs resilience to temporary network errors

* Test NewFactory

* Test config Validate

* Use common collect_cluster_metrics flag

* Test scraper with mocked API

* Add integration_test using containertest

* Add Copyright headers to exported files

* Regenerate with new mdatagen

* Enable authentication after testing

Reuse Logger from params

* Don't unwrap login error

* Update metadata.yaml with PR feedback

* Move createDefaultConfig into factory

* Add to ScrapeErrors, don't use Sugared logging

* Don't save ReceiverCreateSettings

Just copy its logger

* Update expected metrics

* Mask resource_attributes for unpredictable values

* Remove TLS as I couldn't test

* Remove unused scraper options

Add integration build tag
Move consts to file they're used in

* Add clientFactory to receiver struct

Test scrape with `collect_cluster_metrics` enabled

* Update CODEOWNERS, CHANGELOG.md

* Run make gofmt, check unchecked err

* Add aerospike to TestDefaultReceivers, update expected metrics

* Add README

* Make goporto

* Update image in integration_test

* Use status header from #10116

* Remove go.opentelemetry.io/collector/model dependency

* Attribute name fix, regenerate

* Split scraping into scrapeNamespaces

Make clientFactoryFunc type

* Record partial error for failed namespace

Simplify scraper_test cases for empty metrics

* Simplify clientFactory, update expected.json

* Update CHANGELOG.md

* Try to login again on SESSION_EXPIRED

* Fix collector version

* Use metric input_type for parsing response

- Update client to return maps
- Update tests
- Remove internal/model

* Use human-friendly names in attributes

- aggr -> aggregation
- bg -> background

* Require non-negative timeout

Add test case

* Fix LICENSE headers

* node_name -> node.name

Use IgnoreResourceAttributeValue from scrapertest

* Add testdata/config.yaml

* Make gotidy

* Make gotidy

* Remove unnecessary resource_attribute masking

* Warn when metric pair is in unexpected format

Add logger to defaultASClient

* Update receiver/aerospikereceiver/README.md

Co-authored-by: Daniel Jaglowski <[email protected]>
@Frapschen Frapschen mentioned this issue Jun 17, 2022
Closed
6 tasks
This was referenced Jun 18, 2022
Closed
Merged
Merged
Merged
Merged
@Frapschen
Copy link
Contributor

@codeboten I want to apply become a member of opentelemetry community,can you sponsored me?

@codeboten
Copy link
Contributor Author

@codeboten I want to apply become a member of opentelemetry community,can you sponsored me?

@Frapschen sure, open an issue in the community repo https://github.com/open-telemetry/community/blob/main/community-membership.md#member 👍🏻

@Frapschen
Copy link
Contributor

@codeboten I want to apply become a member of opentelemetry community,can you sponsored me?

@Frapschen sure, open an issue in the community repo https://github.com/open-telemetry/community/blob/main/community-membership.md#member 👍🏻

thx,I have opend an issue and have been became a member of counmity.

@TylerHelmuth TylerHelmuth mentioned this issue Jun 30, 2022
Closed
@TylerHelmuth
Copy link
Member

@codeboten should we update this issue to include the Warning Section situation?

@my-git9 my-git9 mentioned this issue Jul 5, 2022
Closed
6 tasks
@schmikei schmikei mentioned this issue Jul 8, 2022
Merged
@mx-psi mx-psi mentioned this issue Jul 13, 2022
Closed
@pmm-sumo pmm-sumo mentioned this issue Jul 14, 2022
Closed
@TylerHelmuth TylerHelmuth mentioned this issue Jul 29, 2022
Closed
@chalin chalin mentioned this issue Jul 29, 2022
Closed
@kovrus kovrus mentioned this issue Oct 7, 2022
Closed
@github-actions
Copy link
Contributor

github-actions bot commented Nov 9, 2022

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

@github-actions github-actions bot added the Stale label Nov 9, 2022
@fatsheep9146 fatsheep9146 removed the Stale label Feb 2, 2023
@atoulme
Copy link
Contributor

atoulme commented Feb 24, 2023

@codeboten I just ran through all remaining open items and closed them as all had been completed. I think this issue is ready to be marked complete.

@djaglowski
Copy link
Member

Thanks to all who helped organize and complete this standardization effort!

@svrnm svrnm mentioned this issue Aug 8, 2023
Merged
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 good first issue Good for newcomers help wanted Extra attention is needed priority:p3 Lowest
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[docs] add status header for zipkinreceiver my-git9/opentelemetry-collector-contrib
8 participants
@atoulme @codeboten @jkowall @djaglowski @fatsheep9146 @TylerHelmuth @Frapschen @pmm-sumo