docs(tracer): include environment variables

[barreeeiroo]

Issue number: #2923

Clarifies Tracer's documentation page by including its related environment variables.

Summary

This PR improves Tracer's documentation page by including its related environment variables. They were only included on the main page, though it may be useful to also mention them in their corresponding section.

Changes

Under the Getting started section, a table listing all Tracer's environment variables has been included. It also mentions the preference order (method parameter overrides environment variable).

User experience

When navigating through documentation, developers will now find the environment variables for Tracer on its page. It is useful as it allows us to quickly understand the behaviour of these environment variables by Ctrl+F'ing them.

This comes from personal experience, as I found out about these environment variables by checking the parameters of Tracer decorators' source code. But when going to Tracer's documentation page, I couldn't find these environment variables, until I realized they were only in the main page.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

No

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[github-actions]

No related issues found. Please ensure there is an open issue related to this change to avoid significant delays or closure.

[heitorlessa]

Two tiny changes so we can standardize it later.

We require an issue for every PR, so I'll create a documentation issue for this to prioritize it.

[heitorlessa]

could you add them under a new subsection Environment variables, please?

It'll make it easier for customers to link to that section, and elsewhere in the docs. We could then follow this structure for anything else we missed :-)

[heitorlessa]

Suggested change

	Both `POWERTOOLS_TRACER_CAPTURE_RESPONSE` and `POWERTOOLS_TRACER_CAPTURE_ERROR` can be set on a per-method basis (see [Advanced](#advanced)), overriding the environment variable value.
	Both [`POWERTOOLS_TRACER_CAPTURE_RESPONSE`](#disabling-response-auto-capture) and [`POWERTOOLS_TRACER_CAPTURE_ERROR`](#disabling-exception-auto-capture) can be set on a per-method basis, consequently overriding the environment variable value.

Adding link to each specific section to improve the experience ;-)

[barreeeiroo]

Two tiny changes so we can standardize it later.

We require an issue for every PR, so I'll create a documentation issue for this to prioritize it.

No worries, I'll update it this afternoon. By the way, now that you mention standardizing it, I could retarget the PR and, rather than only updating Tracer, update all pages to include this Environment Variables section. Not sure if it's in your roadmap or you only want Traver by now, but it shouldn't take too long and I've already started with Traver, so why not :)

[heitorlessa]

If you can be so kind, why not <3

[barreeeiroo]

Closing in favour of #2925 (includes all pages)