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

[DOC] Improve docs on auto-instrumentation #2928

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lucabelluccini
Copy link

Warn users the agent will only trace database queries if they're made within the context of a sampled transaction. Typically people use the agent with web applications, measuring the latency of requests, with details of operations such as database queries in those requests.

When not using a framework, the user needs to start a transaction using apm.startTransaction before making the query, and end the transaction after the query has completed.

Ideally, it might be just a warning banner with a pointer to https://www.elastic.co/guide/en/apm/agent/nodejs/current/custom-transactions.html

From https://discuss.elastic.co/t/nodejs-apm-does-not-report-postgres-queries/208984/2

Please review the wording. This is just a doc improvement which I would like the docs team to review and backport

Checklist

  • Update documentation

Warn users the agent will only trace database queries if they're made within the context of a sampled transaction. Typically people use the agent with web applications, measuring the latency of requests, with details of operations such as database queries in those requests.

When not using a framework, the user needs to start a transaction using `apm.startTransaction` before making the query, and end the transaction after the query has completed.

Ideally, it might be just a warning banner with a pointer to https://www.elastic.co/guide/en/apm/agent/nodejs/current/custom-transactions.html

From https://discuss.elastic.co/t/nodejs-apm-does-not-report-postgres-queries/208984/2

Please review the wording. This is just a doc improvement which I would like the docs team to review and backport
@lucabelluccini lucabelluccini added docs agent-nodejs Make available for APM Agents project planning. Team:Docs Label for the Observability docs team labels Sep 16, 2022
@apmmachine
Copy link
Contributor

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-10-03T16:19:53.766+0000

  • Duration: 6 min 24 sec

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • run module tests for <modules> : Run TAV tests for one or more modules, where <modules> can be either a comma separated list of modules (e.g. memcached,redis) or the string literal ALL to test all modules

  • run benchmark tests : Run the benchmark test only.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
agent-nodejs Make available for APM Agents project planning. community docs Team:Docs Label for the Observability docs team triage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants