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

log/sdk: Document package #5065

Closed
pellared opened this issue Mar 13, 2024 · 1 comment · Fixed by #5609
Closed

log/sdk: Document package #5065

pellared opened this issue Mar 13, 2024 · 1 comment · Fixed by #5609
Assignees
@pellared
Labels
area:logs Part of OpenTelemetry logs documentation Provides helpful information pkg:SDK Related to an SDK package
Milestone
v1.29.0

Comments

@pellared
Copy link
Member

pellared commented Mar 13, 2024 •
edited
Loading

  • Add package level documentation
  • Add testable examples
@pellared pellared converted this from a draft issue Mar 13, 2024
@pellared pellared added pkg:SDK Related to an SDK package area:logs Part of OpenTelemetry logs documentation Provides helpful information labels Mar 13, 2024
@pellared pellared moved this from Backlog to Todo in Go: Logs (GA) Mar 13, 2024
@pellared pellared self-assigned this Jun 25, 2024
@pellared pellared moved this from Todo to In Progress in Go: Logs (GA) Jun 25, 2024
@pellared
Copy link
Member Author

I am assigning myself, but anyone can work in parallel with me.

This was referenced Jun 25, 2024
Merged
Merged
pellared added a commit that referenced this issue Jun 27, 2024
@pellared @MrAlias
sdk/log: Add altering Processor example (#5550)
cda5094 
Towards #5065

---------

Co-authored-by: Tyler Yahn <[email protected]>
@pellared pellared mentioned this issue Jun 28, 2024
Merged
pellared added a commit that referenced this issue Jul 1, 2024
@pellared
sdk/log: Fix ExampleProcessor_redact to clone the record (#5559)
d7e5001 
Towards #5065

Follow our own docs. From `Processor.Enabled` docs:

> Before modifying a Record, the implementation must use Record.Clone to
create a copy that shares no state with the original.
pellared added a commit that referenced this issue Jul 1, 2024
@pellared
sdk/log: Add filtering Processor example (#5543)
b477e34 
Towards #5065
@pellared pellared mentioned this issue Jul 5, 2024
Merged
pellared added a commit that referenced this issue Jul 6, 2024
@pellared @XSAM
sdk/log: Add package example (#5579)
d5c3319 
Towards #5065

Co-authored-by: Sam Xie <[email protected]>
@pellared pellared mentioned this issue Jul 11, 2024
Merged
@MrAlias MrAlias added this to the v1.29.0 milestone Jul 11, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Go: Logs (GA) Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pellared pellared

Labels
area:logs Part of OpenTelemetry logs documentation Provides helpful information pkg:SDK Related to an SDK package
Projects
Go: Logs (GA)
Status: Done
Milestone
v1.29.0
Development

Successfully merging a pull request may close this issue.

sdk/log: Package documentation pellared/opentelemetry-go
2 participants
@pellared @MrAlias