Skip to content

Commit 80c9167

Browse files
chore(docs): consolidate troubleshooting docs on a single page (PHP SDK)
1 parent 2a3e457 commit 80c9167

File tree

7 files changed

+81
-96
lines changed

7 files changed

+81
-96
lines changed

docs/platforms/php/common/crons/troubleshooting.mdx

Lines changed: 0 additions & 37 deletions
This file was deleted.

docs/platforms/php/common/profiling/troubleshooting.mdx

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/platforms/php/common/tracing/troubleshooting/index.mdx

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/platforms/php/common/troubleshooting/index.mdx

Lines changed: 73 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ sidebar_order: 9000
44
description: "Troubleshooting steps for PHP"
55
---
66

7-
## Log SDK internal events
7+
## General
8+
9+
<Expandable title="How can I log internal SDK events?">
810

911
A good first step to debug SDK issues is using the `logger` option. For your convenience, the SDK ships with two implementations, `DebugFileLogger` and `DebugStdOutLogger`.
1012

@@ -31,7 +33,76 @@ sentry/sentry: [warning] The profile does not contain enough samples, the profil
3133
sentry/sentry: [info] Sent transaction [59390dc9dd934c0290d8cdc7a589da82] to o1.ingest.sentry.io [project:1]. Result: "success" (status: 200).
3234
3335
```
36+
</Expandable>
3437

35-
## Missing Variables in Stack Traces
38+
<Expandable title="Missing Variables in Stack Traces">
3639

3740
This is caused by the PHP configuration. PHP 7.4 introduced a new .ini setting, `zend.exception_ignore_args`, that will ignore stack trace arguments. Check your .ini file to ensure this setting is set to `Off` or `0`.
41+
42+
</Expandable>
43+
44+
<Expandable title="Why was my tag value truncated?">
45+
46+
Currently, every tag has a maximum character limit of 200 characters. Tags over the 200 character limit will become truncated, losing potentially important information. To retain this data, you can split data over several tags instead.
47+
48+
For example, a 200+ character tagged request:
49+
50+
`https://empowerplant.io/api/0/projects/ep/setup_form/?user_id=314159265358979323846264338327&tracking_id=EasyAsABC123OrSimpleAsDoReMi&product_name=PlantToHumanTranslator&product_id=161803398874989484820458683436563811772030917980576`
51+
52+
The 200+ character request above will become truncated to:
53+
54+
`https://empowerplant.io/api/0/projects/ep/setup_form/?user_id=314159265358979323846264338327&tracking_id=EasyAsABC123OrSimpleAsDoReMi&product_name=PlantToHumanTranslator&product_id=1618033988749894848`
55+
56+
<PlatformContent includePath="performance/control-data-truncation" />
57+
58+
</Expandable>
59+
60+
61+
## Profiling
62+
63+
<Expandable title="Why am I not seeing any profiling data?">
64+
65+
If you don't see any profiling data in [sentry.io](https://sentry.io), you can try the following:
66+
67+
- Ensure that <PlatformLink to="/tracing/">Tracing is enabled</PlatformLink>.
68+
- Ensure that the automatic instrumentation is sending performance data to Sentry by going to the **Performance** page in [sentry.io](https://sentry.io).
69+
- Ensure that the <PlatformLink to="/tracing/instrumentation/custom-instrumentation">custom instrumentation</PlatformLink> is sending performance data to Sentry by going to the **Performance** page in [sentry.io](https://sentry.io).
70+
- Ensure the <PlatformLink to="/integrations/#environmentintegration">`Sentry\Integration\EnvironmentIntegration`</PlatformLink> is enabled.
71+
- Enable the <PlatformLink to="/configuration/options/#logger">logger</PlatformLink> to see what the SDK is doing under the hood.
72+
73+
</Expandable>
74+
75+
## Crons
76+
77+
78+
<PlatformContent includePath="crons/troubleshooting" />
79+
80+
<Expandable title="Why aren't recurring job errors showing up on my monitor details page?">
81+
82+
You may not have <PlatformLink to="/crons/#connecting-errors-to-cron-monitors">linked errors to your monitor</PlatformLink>.
83+
84+
</Expandable>
85+
86+
<Expandable title="Why am I not receiving alerts when my monitor fails?">
87+
88+
You may not have <PlatformLink to="/crons/#alerts">set up alerts for your monitor</PlatformLink>.
89+
90+
</Expandable>
91+
92+
<Expandable title="What is the crons data retention policy for check-ins?">
93+
94+
Our current data retention policy is 90 days.
95+
96+
</Expandable>
97+
98+
<Expandable title="Do you support a monitor schedule with a six-field crontab expression?">
99+
100+
Currently, we only support crontab expressions with five fields.
101+
102+
</Expandable>
103+
104+
<Expandable title="My jobs time out because all of them start at the same time and sometimes they fail, how can I fix that?">
105+
106+
You can either consider running your jobs in the background OR use the `checkInMargin` option to make the window larger.
107+
108+
</Expandable>

docs/platforms/php/guides/laravel/profiling/troubleshooting.mdx

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/platforms/php/guides/symfony/profiling/troubleshooting.mdx

Lines changed: 0 additions & 12 deletions
This file was deleted.

redirects.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -972,6 +972,14 @@ const userDocsRedirects = [
972972
source: '/platforms/ruby/:productfeature/troubleshooting/:path*',
973973
destination: '/platforms/ruby/troubleshooting/:path*',
974974
},
975+
{
976+
source: '/platforms/php/guides/:guide/:productfeature/troubleshooting/:path*',
977+
destination: '/platforms/php/guides/:guide/troubleshooting/:path*',
978+
},
979+
{
980+
source: '/platforms/php/:productfeature/troubleshooting/:path*',
981+
destination: '/platforms/php/troubleshooting/:path*',
982+
},
975983
];
976984

977985
/**

0 commit comments

Comments
 (0)