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

[docs] Add status header for humio exporter #10319

Merged
merged 3 commits into from
May 27, 2022
Merged

[docs] Add status header for humio exporter #10319

merged 3 commits into from
May 27, 2022

Conversation

Frapschen
Copy link
Contributor

Description:
Add status header for humio exporter.

@Frapschen Frapschen requested review from a team and Aneurysm9 May 25, 2022 08:16
@mx-psi mx-psi added the Skip Changelog PRs that do not require a CHANGELOG.md entry label May 25, 2022
TylerHelmuth
TylerHelmuth approved these changes May 25, 2022
View reviewed changes
Copy link
Member

@TylerHelmuth TylerHelmuth left a comment

Choose a reason for hiding this comment

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

/cc @Xitric as code owner to verify beta stability

exporter/humioexporter/README.md Outdated
| Status | |
| ------------------------ |-----------|
| Stability | [beta] |
| Supported pipeline types | trace |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| Supported pipeline types | trace |
| Supported pipeline types | traces |

@codeboten codeboten mentioned this pull request May 25, 2022
Closed
@Xitric
Copy link
Contributor

Xitric commented May 25, 2022 •
edited
Loading

Yes, I can verify that this exporter only has beta stability. To my knowledge, it has only been used by a small handful of people, including myself.

@djaglowski
Copy link
Member

djaglowski commented May 26, 2022 •
edited
Loading

check-links failure appears to be related to the file modified by this PR, but unrelated to actual changes on this PR. If I'm not mistaken, this is working as intended, so should be addressed as part of or prior to this PR.

FILE: exporter/humioexporter/README.md

  [✓] https://github.com/open-telemetry/opentelemetry-collector#beta → Status: 200
  [✓] https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib → Status: 200
  [✓] https://docs.humio.com/reference/api/ingest/ → Status: 200
  ERROR: 2 dead links found!
  [✖] #Tagging → Status: 404
  [✖] #Inherited-Options → Status: 404
  [✓] https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md#tls-configuration-settings → Status: 200
  [✓] https://docs.humio.com/docs/ingesting-data/ingest-tokens/ → Status: 200
  [✓] testdata/config.yaml → Status: 200
  [✓] https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/confighttp#client-configuration → Status: 200
  [✓] https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md#configuration → Status: 200
  [✓] https://docs.humio.com/docs/parsers/tagging/ → Status: 200
  [✓] https://docs.humio.com/reference/api/cluster-management-api/#setup-grouping-of-tags → Status: 200

  12 links checked.
  [✖] #Tagging → Status: 404
  [✖] #Inherited-Options → Status: 404

@Xitric
Copy link
Contributor

Xitric commented May 26, 2022

Am I mistaken, or do those links work perfectly fine?

There seems to be a discussion on the markdown-link-check repository and some open issues stating that a regression on fragment anchors has been introduced recently. See tcort/markdown-link-check#91.

@TylerHelmuth
Copy link
Member

TylerHelmuth commented May 26, 2022 •
edited
Loading

I think core had this same issue: open-telemetry/opentelemetry-collector#5118

The Core Repo (and our workflow as well) stopped using the action and started using the npm package directly so we should have the latest version. I think the issue you provided is more relevant.

@TylerHelmuth
Copy link
Member

Core is able to get anchors to work tho: https://github.com/open-telemetry/opentelemetry-collector/runs/6492891036?check_suite_focus=true.

TylerHelmuth
TylerHelmuth reviewed May 26, 2022
View reviewed changes
exporter/humioexporter/README.md Outdated
| Supported pipeline types | traces |
| Distributions | [contrib] |

Exports data to Humio using JSON over the HTTP [Ingest API](https://docs.humio.com/reference/api/ingest/).

> :construction: This exporter is currently intended for evaluation purposes only! It has yet to be enabled in the build.
Copy link
Member

Choose a reason for hiding this comment

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

Should this be removed? The exporter is in the contrib distribution

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, we forgot to remove that comment way back when the exporter was enabled. My former colleague and I have evaluated it internally (we are not affiliated with Humio), so we do consider it sufficiently stable for beta.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok ,I will remove the comment.

@TylerHelmuth
Copy link
Member

@Frapschen @Xitric the anchor links need to be lowercase: https://github.com/TylerHelmuth/opentelemetry-collector-contrib/runs/6612328113?check_suite_focus=true

@Xitric
Copy link
Contributor

Xitric commented May 26, 2022

@TylerHelmuth Alright, that is good to know. I learned something new today. Is this something you or @Frapschen can handle? I am currently on vacation and only on my phone.

@TylerHelmuth TylerHelmuth mentioned this pull request May 26, 2022
Merged
@TylerHelmuth
Copy link
Member

@TylerHelmuth Alright, that is good to know. I learned something new today. Is this something you or @Frapschen can handle? I am currently on vacation and only on my phone.

@Frapschen as the PR creator please update the anchor links

@Frapschen
Copy link
Contributor Author

done:)

djaglowski
djaglowski approved these changes May 27, 2022
View reviewed changes
Copy link
Member

@djaglowski djaglowski left a comment

Choose a reason for hiding this comment

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

Thank you, @Frapschen

@djaglowski djaglowski merged commit 1477356 into open-telemetry:main May 27, 2022
kentquirk pushed a commit to McSick/opentelemetry-collector-contrib that referenced this pull request Jun 14, 2022
@Frapschen @kentquirk
[docs] Add status header for humio exporter (open-telemetry#10319)
c91d932 
* Add status header for humio

* update for reviewer's suggestion

* apply reviewer's suggestion
@Frapschen Frapschen deleted the Add_status_header_for_humio branch July 7, 2022 05:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TylerHelmuth TylerHelmuth TylerHelmuth approved these changes

@Xitric Xitric Xitric left review comments

@djaglowski djaglowski djaglowski approved these changes

@Aneurysm9 Aneurysm9 Awaiting requested review from Aneurysm9

Assignees

@Aneurysm9 Aneurysm9

Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Frapschen @Xitric @djaglowski @TylerHelmuth @Aneurysm9 @mx-psi