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

Add S3 Bucket and Object Key to S3 instrumentation (OTel) #788

Merged
merged 4 commits into from
Apr 26, 2023

Conversation

david-luna
Copy link
Member

@david-luna david-luna commented Apr 21, 2023

Updated the AWS S3 Spec by adding Bucket and Object Key into OpenTelemetry attributes (otel)

  • May the instrumentation collect sensitive information, such as secrets or PII (ex. in headers)?
    • Yes
      • Add a section to the spec how agents should apply sanitization (such as sanitize_field_names)
    • No
      • Why? Bucket and Object Key does not hold personal information
    • n/a
  • Create PR as draft
  • Approval by at least one other agent
  • Mark as Ready for Review (automatically requests reviews from all agents and PM via CODEOWNERS)
    • Remove PM from reviewers if impact on product is negligible
    • Remove agents from reviewers if the change is not relevant for them
  • Approved by at least 2 agents + PM (if relevant)
  • Merge after 7 days passed without objections
    To auto-merge the PR, add /schedule YYYY-MM-DD to the PR description.
  • Create implementation issues through the meta issue template (this will automate issue creation for individual agents)
  • If this spec adds a new dynamic config option, add it to central config.

Closes: #760

specs/agents/tracing-instrumentation-db.md Outdated Show resolved Hide resolved
@trentm
Copy link
Member

trentm commented Apr 21, 2023

@AlexanderWert, others: Do you think we should consider also adding otel.attributes["aws.s3.bucket"] et al for Lambda transactions that are S3-triggered? (https://github.com/elastic/apm/blob/main/specs/agents/tracing-instrumentation-aws-lambda.md#s3)

@AlexanderWert
Copy link
Member

AlexanderWert commented Apr 21, 2023

@AlexanderWert, others: Do you think we should consider also adding otel.attributes["aws.s3.bucket"] et al for Lambda transactions that are S3-triggered? (https://github.com/elastic/apm/blob/main/specs/agents/tracing-instrumentation-aws-lambda.md#s3)

Good point @trentm! Yes, I think that makes sense.

@gregkalapos gregkalapos self-requested a review April 24, 2023 15:14
Copy link
Contributor

@gregkalapos gregkalapos left a comment

Choose a reason for hiding this comment

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

LGTM (once #788 (comment) is merged).

Co-authored-by: Trent Mick <trent.mick@elastic.co>
@david-luna david-luna marked this pull request as ready for review April 26, 2023 08:16
@david-luna david-luna requested review from a team as code owners April 26, 2023 08:16
@david-luna
Copy link
Member Author

@AlexanderWert, others: Do you think we should consider also adding otel.attributes["aws.s3.bucket"] et al for Lambda transactions that are S3-triggered? (https://github.com/elastic/apm/blob/main/specs/agents/tracing-instrumentation-aws-lambda.md#s3)

Good point @trentm! Yes, I think that makes sense.

I'd prefer to have it separately. I'll create a spec issue and one for the agents that may implement it.

Copy link
Member

@AlexanderWert AlexanderWert left a comment

Choose a reason for hiding this comment

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

LGTM (just added a minor syntactical proposal to make it consistent)

specs/agents/tracing-instrumentation-db.md Outdated Show resolved Hide resolved
specs/agents/tracing-instrumentation-db.md Outdated Show resolved Hide resolved
david-luna and others added 2 commits April 26, 2023 11:38
Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
Co-authored-by: Alexander Wert <AlexanderWert@users.noreply.github.com>
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.

[META 759] Spec: Add S3 Bucket and Object Key to S3 instrumentation
7 participants