Skip to content

Commit 7887511

Browse files
chore(docs): consolidate troubleshooting docs on a single page (Ruby SDK) (#12708)
1 parent 81d6664 commit 7887511

File tree

5 files changed

+76
-68
lines changed

5 files changed

+76
-68
lines changed

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

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

docs/platforms/ruby/common/profiling/troubleshooting/index.mdx

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

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

Lines changed: 0 additions & 21 deletions
This file was deleted.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Troubleshooting
3+
description: "Learn how to troubleshoot your SDK setup."
4+
sidebar_order: 9000
5+
---
6+
7+
## General
8+
9+
<Expandable title="Why was my tag value truncated?">
10+
11+
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.
12+
13+
For example, a 200+ character tagged request:
14+
15+
`https://empowerplant.io/api/0/projects/ep/setup_form/?user_id=314159265358979323846264338327&tracking_id=EasyAsABC123OrSimpleAsDoReMi&product_name=PlantToHumanTranslator&product_id=161803398874989484820458683436563811772030917980576`
16+
17+
The 200+ character request above will become truncated to:
18+
19+
`https://empowerplant.io/api/0/projects/ep/setup_form/?user_id=314159265358979323846264338327&tracking_id=EasyAsABC123OrSimpleAsDoReMi&product_name=PlantToHumanTranslator&product_id=1618033988749894848`
20+
21+
</Expandable>
22+
23+
## Profiling
24+
25+
<Expandable title="Why am I not seeing any profiling data?">
26+
27+
If you don't see any profiling data in [sentry.io](https://sentry.io), you can try the following:
28+
29+
- Ensure that <PlatformLink to="/tracing/">Tracing is enabled</PlatformLink>.
30+
- Ensure that the automatic instrumentation is sending performance data to Sentry by going to the **Performance** page
31+
in [sentry.io](https://sentry.io).
32+
- If the automatic instrumentation is not sending performance data, try using <PlatformLink
33+
to="/tracing/instrumentation/custom-instrumentation">custom instrumentation</PlatformLink>.
34+
- Enable <PlatformLink to="/configuration/options/#debug">debug mode</PlatformLink> in the SDK and check the logs.
35+
36+
### Limitations
37+
38+
Profiles for multi-threaded servers like `puma` might not capture frames correctly when async I/O is happening. This
39+
is a limitation of `stackprof`.
40+
</Expandable>
41+
42+
## Crons
43+
44+
<PlatformContent includePath="crons/troubleshooting" />
45+
46+
<Expandable title="Why aren't recurring job errors showing up on my monitor details page?">
47+
48+
You may not have <PlatformLink to="/crons/#connecting-errors-to-cron-monitors">linked errors to your monitor</PlatformLink>.
49+
50+
</Expandable>
51+
52+
<Expandable title="Why am I not receiving alerts when my monitor fails?">
53+
54+
You may not have <PlatformLink to="/crons/#alerts">set up alerts for your monitor</PlatformLink>.
55+
56+
</Expandable>
57+
58+
<Expandable title="What is the crons data retention policy for check-ins?">
59+
60+
Our current data retention policy is 90 days.
61+
62+
</Expandable>
63+
64+
<Expandable title="Do you support a monitor schedule with a six-field crontab expression?">
65+
66+
Currently, we only support crontab expressions with five fields.
67+
68+
</Expandable>

redirects.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -964,6 +964,14 @@ const userDocsRedirects = [
964964
source: '/product/explore/feature-flags/:path*',
965965
destination: '/product/issues/issue-details/feature-flags/:path*',
966966
},
967+
{
968+
source: '/platforms/ruby/guides/:guide/:productfeature/troubleshooting/:path*',
969+
destination: '/platforms/ruby/guides/:guide/troubleshooting/:path*',
970+
},
971+
{
972+
source: '/platforms/ruby/:productfeature/troubleshooting/:path*',
973+
destination: '/platforms/ruby/troubleshooting/:path*',
974+
},
967975
];
968976

969977
/**

0 commit comments

Comments
 (0)