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

docs: add some OTel attributes for DynamoDB spec #817

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

david-luna
Copy link
Member

@david-luna david-luna commented Jul 18, 2023

This PR adds a couple of OTel attributes in DynamoDB instrumentation. These attributes are:

  • table_names which is used in all commands affecting tables (putItem, deleteItem, updateItem, createTable, updateTable, deleteTable, ...)
  • projection which is present in query and getItem commands

Having this information will be relevant to when analysing which table, and projection if applies, triggered the error or a slow execution.

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? table names and query projection does not contain PII
  • 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](https://github.com/elastic/apm/blob/main/specs/agents/configuration.md#adding-a-new-configuration-option).

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.

2 participants