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 guidelines for observability in the components #2436

Merged
merged 3 commits into from
Apr 9, 2021
Merged

Add guidelines for observability in the components #2436

merged 3 commits into from
Apr 9, 2021

Conversation

jpkrohling
Copy link
Member

As part of #2430, this PR adds guidelines for component developers on how to appropriately make their components observable.

Signed-off-by: Juraci Paixão Kröhling [email protected]

@jpkrohling jpkrohling requested a review from a team February 2, 2021 15:53
@codecov
Copy link

codecov bot commented Feb 2, 2021 •
edited
Loading

Codecov Report

Merging #2436 (e7f1fe0) into main (8cac172) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2436   +/-   ##
=======================================
  Coverage   91.66%   91.66%           
=======================================
  Files         287      287           
  Lines       15221    15221           
=======================================
  Hits        13953    13953           
  Misses        865      865           
  Partials      403      403

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8cac172...e7f1fe0. Read the comment docs.

bogdandrutu
bogdandrutu reviewed Feb 6, 2021
View reviewed changes
CONTRIBUTING.md Outdated
Comment on lines 237 to 238
Out of the box, your users should be able to observe the state of your component.
The collector exposes a `/metrics` endpoint where your metrics will land.
Copy link
Member

Choose a reason for hiding this comment

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

Prometheus /metrics endpoint?

Copy link
Member Author

Choose a reason for hiding this comment

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

OpenMetrics would be more accurate, I suppose.

@jpkrohling jpkrohling force-pushed the jpkrohling/add-item-about-making-component-observable branch from 94e573f to 629d8ba Compare February 8, 2021 11:11
@github-actions
Copy link
Contributor

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Feb 16, 2021
@jpkrohling
Copy link
Member Author

@bogdandrutu, would you please review/merge this one?

@github-actions github-actions bot removed the Stale label Feb 17, 2021
tigrannajaryan
tigrannajaryan reviewed Feb 18, 2021
View reviewed changes
@jpkrohling jpkrohling force-pushed the jpkrohling/add-item-about-making-component-observable branch from 629d8ba to 2a16748 Compare February 23, 2021 13:22
@github-actions
Copy link
Contributor

github-actions bot commented Mar 3, 2021

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Mar 3, 2021
@jpkrohling jpkrohling closed this Mar 3, 2021
@jpkrohling jpkrohling reopened this Mar 3, 2021
@jpkrohling
Copy link
Member Author

@bogdandrutu, @tigrannajaryan, kindly re-review this one, please.

@jpkrohling jpkrohling removed the Stale label Mar 3, 2021
@github-actions
Copy link
Contributor

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Mar 11, 2021
@jpkrohling
Copy link
Member Author

@tigrannajaryan, do you think this should be closed for now? I think the current state of this PR might be useful, but not complete.

@tigrannajaryan
Copy link
Member

I think the first two paragraphs are fine. If you want to keep just that part then we can merge it.

@github-actions github-actions bot removed the Stale label Mar 12, 2021
@github-actions
Copy link
Contributor

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Mar 19, 2021
@jpkrohling jpkrohling force-pushed the jpkrohling/add-item-about-making-component-observable branch from 4da9d80 to 2558142 Compare March 19, 2021 08:28
@jpkrohling
Copy link
Member Author

PR updated.

@github-actions github-actions bot removed the Stale label Mar 20, 2021
@github-actions
Copy link
Contributor

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Mar 28, 2021
@jpkrohling
Copy link
Member Author

ping @tigrannajaryan

@jpkrohling jpkrohling removed the Stale label Mar 30, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Apr 7, 2021

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Apr 7, 2021
@jpkrohling jpkrohling removed the Stale label Apr 7, 2021
@jpkrohling
Copy link
Member Author

ping @tigrannajaryan

tigrannajaryan
tigrannajaryan approved these changes Apr 7, 2021
View reviewed changes
@jpkrohling jpkrohling force-pushed the jpkrohling/add-item-about-making-component-observable branch from 2558142 to e7f1fe0 Compare April 8, 2021 13:34
@tigrannajaryan tigrannajaryan merged commit 9c3d27f into open-telemetry:main Apr 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tigrannajaryan tigrannajaryan tigrannajaryan approved these changes

@bogdandrutu bogdandrutu Awaiting requested review from bogdandrutu

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jpkrohling @tigrannajaryan @bogdandrutu