-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Initial content for Symfony performance integrations #3470
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
Merged
PeloWriter
merged 14 commits into
master
from
update/symfony-php-performance-integrations
May 3, 2021
Merged
Changes from 11 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
da63b92
initial content for Symfony performance integrations
PeloWriter 8caeefb
ref: Add code snippets
HazAT 050c4aa
update to enabled
PeloWriter 26a6ee9
fix typo
PeloWriter 24c1c51
update based on feedback
PeloWriter d5c78a2
update code samples
PeloWriter 1324f2c
Update src/platforms/php/guides/symfony/performance/pm-integrations.mdx
PeloWriter e622f5a
Update src/platforms/php/guides/symfony/performance/pm-integrations.mdx
PeloWriter a25bfcc
respond to review feedback
PeloWriter 154d8c2
update error types default
PeloWriter adcb478
respond to review feedback
PeloWriter e7ca20b
Update src/platforms/php/guides/symfony/performance/pm-integrations.mdx
PeloWriter 38be4f7
Update src/platforms/php/guides/symfony/performance/pm-integrations.mdx
PeloWriter 2d927bd
Update src/platforms/php/common/integrations.mdx
PeloWriter File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
src/platforms/php/guides/symfony/performance/pm-integrations.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| --- | ||
| title: Performance Integrations | ||
| description: "Learn about the the integrations Sentry provides for performance monitoring and how to configure them." | ||
| sidebar_order: 500 | ||
| --- | ||
|
|
||
| The Symfony SDK offers integrations to support tracing that are enabled by default. To use them, update to the latest version of the SDK. | ||
|
|
||
| If the vendors (DBAL, Cache, and Twig) are installed, `enabled` will be set to `true`, so it's likely that this configuration is the same in your app. | ||
|
|
||
| These integrations are hooking into critical paths of the framework and of the vendors. As a result, there may be a performance penalty. If you are updating from a previous version or installing the SDK, you may observe a degradation of your app performance, though it may not be noticeable. If you need to disable tracing, you can do so by setting `enabled` to `false`. | ||
|
|
||
| ```yaml {filename:config/packages/sentry.yaml} | ||
| sentry: | ||
| tracing: | ||
| enabled: true | ||
| dbal: # DB queries | ||
| enabled: true | ||
| cache: | ||
| enabled: true | ||
| twig: # templating engine | ||
| enabled: true | ||
| ``` | ||
| You can adjust the integrations to your needs if you want to disable a specific integrations. | ||
PeloWriter marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ### Dbal | ||
PeloWriter marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| This integration supports tracking database queries as Spans. Enabling this option will create Spans for your queries. | ||
| It is enabled by default. To disable tracking database queries, set `enabled` to `false`. | ||
|
|
||
| ```yaml {filename:config/packages/sentry.yaml} | ||
| sentry: | ||
| tracing: | ||
| dbal: # DB queries | ||
| enabled: true | ||
| ``` | ||
|
|
||
| ### Twig | ||
|
|
||
| This integration adds distributed tracing for Twig template rendering using Sentry. | ||
|
|
||
| It is enabled by default. To disable it, set `enabled` to `false`. | ||
PeloWriter marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ```yaml {filename:config/packages/sentry.yaml} | ||
| sentry: | ||
| tracing: | ||
| twig: # templating engine | ||
| enabled: true | ||
| ``` | ||
|
|
||
| ### Cache | ||
|
|
||
| This integration adds support for distributed tracing of cache pools. | ||
|
|
||
| It is enabled by default. To disable it, set `enabled` to `false`. | ||
PeloWriter marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ```yaml {filename:config/packages/sentry.yaml} | ||
| sentry: | ||
| tracing: | ||
| cache: # cache pools | ||
| enabled: true | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.