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.

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

Blog post: HTTP semantic conventions declared stable #3472

Merged
merged 45 commits into from
Nov 4, 2023

Conversation

trask
Copy link
Member

@trask trask commented Nov 2, 2023

Would love to publish this before KubeCon.

Of course, we still have to declare HTTP semconv stabillity first. There's a decent chance that will happen on Friday (11/3). DONE!

Closes open-telemetry/semantic-conventions#43


Preview: https://deploy-preview-3472--opentelemetry.netlify.app/blog/2023/http-conventions-declared-stable/

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Nice blog. I made a first pass. See inline comments.

content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
@trask trask force-pushed the http-semconv-stability branch 5 times, most recently from a9796fc to a93ef48 Compare November 3, 2023 03:49
@trask trask force-pushed the http-semconv-stability branch from a93ef48 to 971f27a Compare November 3, 2023 03:50
@trask trask force-pushed the http-semconv-stability branch from 971f27a to 29fe8fc Compare November 3, 2023 04:01
@trask trask marked this pull request as ready for review November 3, 2023 04:03
@trask trask requested review from a team November 3, 2023 04:03
@trask trask changed the title HTTP semconv stability blog post Blog post: HTTP semantic conventions declared stable Nov 3, 2023
Copy link
Member

@mhausenblas mhausenblas left a comment

Choose a reason for hiding this comment

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

LGTM and left some comments inline.

- The `url.*` namespace, which can be reused in the future by non-HTTP
semantic conventions
- The `client.*` and `server.*` namespaces, which are easier to reason about
and work better on logs (where there is no span kind)
Copy link
Member

Choose a reason for hiding this comment

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

What exactly does that mean?

Copy link
Member Author

Choose a reason for hiding this comment

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

I've expanded this bullet, lmk if it helps

namespaces
- Further alignment with Prometheus by adopting seconds as the standard unit for
metrics
- Attributes which are less generally useful are no longer captured by default
Copy link
Member

Choose a reason for hiding this comment

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

As a reader, not sure I understand what you mean with "to implement a transition plan". What do I have to do, if anything? Are there scripts that help me automate things? Maybe I don't need to do anything since OpenTelemetry is taking care of it, etc.

I suggest being more explicit about expectations and shared responsibility model.

Copy link
Member Author

Choose a reason for hiding this comment

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

thx, I redid the transition plan section to try to make it clearer, ptal

content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

@trask: I've added the first table, PTAL and merge if you like it. I'll work on the other sections after that.

content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
trask and others added 2 commits November 3, 2023 10:17
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

This is looking great! One final copyedit. 🚀

content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
@chalin
Copy link
Contributor

chalin commented Nov 4, 2023

Thanks @mhausenblas
Pinging @open-telemetry/blog-approvers
(Also let's remember to fix the date.)

Copy link
Contributor

@cartermp cartermp left a comment

Choose a reason for hiding this comment

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

Let's make this monday of next week and merge.

content/en/blog/2023/http-conventions-declared-stable.md Outdated Show resolved Hide resolved
@cartermp cartermp merged commit 3dc16be into open-telemetry:main Nov 4, 2023
12 checks passed
@chalin
Copy link
Contributor

chalin commented Nov 6, 2023

I re-triggered the production build, and the HTTP semconv is now live! https://opentelemetry.io/blog/2023/http-conventions-declared-stable/

@trask trask deleted the http-semconv-stability branch October 14, 2024 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Produce documentation that outlines http changes from 1.20.0
5 participants