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

feat: OpenTelemetry logs #7583

Merged
merged 8 commits into from
Jul 23, 2024
Merged

feat: OpenTelemetry logs #7583

merged 8 commits into from
Jul 23, 2024

Conversation

samugi
Copy link
Contributor

@samugi samugi commented Jun 26, 2024

Description

docs for Kong/kong#13291
This PR adds OpenTelemetry formatted logs as a new
signal supported by the OpenTelemetry plugin.

It patches the ngx.log function (and adapts kong PDK log) to collect the logged lines and
enrich them with additional context info:

severity
introspection details
timestamp
And for request-scoped logs also:

Request ID
Trace ID
Span ID
Trace flags
The log entries are protobuf-serialized and sent to the endpoint
configured in the OpenTelemetry plugin's config.logs_endpoint field.

Testing instructions

Preview link:

Checklist

KAG-4779

@samugi samugi added review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? review:copyedit Request for writer review. labels Jun 26, 2024
@samugi samugi requested a review from a team as a code owner June 26, 2024 15:49
@samugi samugi marked this pull request as draft June 26, 2024 15:49
@samugi samugi added this to the Gateway 3.8 milestone Jun 26, 2024
Copy link

netlify bot commented Jun 26, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit a97a90c
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/669f4fb9d9ce510008712ea0
😎 Deploy Preview https://deploy-preview-7583--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 93 (🟢 up 1 from production)
Accessibility: 93 (🟢 up 1 from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@samugi samugi changed the title feat(OpenTelemetry): support opentelemetry logs feat(observability): OpenTelemetry logs Jul 5, 2024
@samugi samugi marked this pull request as ready for review July 5, 2024 15:16
docs for Kong/kong#13291

Update app/_hub/kong-inc/opentelemetry/overview/_index.md

Co-authored-by: Hans Hübner <hans.huebner@gmail.com>
@samugi
Copy link
Contributor Author

samugi commented Jul 5, 2024

ready for review @Kong/docs-maintainers along with: Kong/docs-plugin-toolkit#38 - thanks

@lena-larionova lena-larionova self-assigned this Jul 8, 2024
Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

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

Minor phrasing and formatting edits.

app/_hub/kong-inc/opentelemetry/overview/_index.md Outdated Show resolved Hide resolved
app/_hub/kong-inc/opentelemetry/overview/_index.md Outdated Show resolved Hide resolved
app/_hub/kong-inc/opentelemetry/overview/_index.md Outdated Show resolved Hide resolved
app/_hub/kong-inc/opentelemetry/overview/_index.md Outdated Show resolved Hide resolved
app/_hub/kong-inc/opentelemetry/overview/_index.md Outdated Show resolved Hide resolved
app/_hub/kong-inc/opentelemetry/overview/_index.md Outdated Show resolved Hide resolved
app/_hub/kong-inc/opentelemetry/overview/_index.md Outdated Show resolved Hide resolved
samugi and others added 7 commits July 23, 2024 08:35
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

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

LGTM

@lena-larionova lena-larionova merged commit e512f09 into main Jul 23, 2024
15 checks passed
@lena-larionova lena-larionova deleted the feat/otel-plugin-logs branch July 23, 2024 14:42
@Guaris Guaris changed the title feat(observability): OpenTelemetry logs feat: OpenTelemetry logs Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:copyedit Request for writer review. review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly?
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants