Skip to content

chore(docs): consolidate troubleshooting docs on a single page (Ruby SDK) #12708

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
merged 1 commit into from
Feb 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions docs/platforms/ruby/common/crons/troubleshooting.mdx

This file was deleted.

16 changes: 0 additions & 16 deletions docs/platforms/ruby/common/profiling/troubleshooting/index.mdx

This file was deleted.

21 changes: 0 additions & 21 deletions docs/platforms/ruby/common/tracing/troubleshooting/index.mdx

This file was deleted.

68 changes: 68 additions & 0 deletions docs/platforms/ruby/common/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: Troubleshooting
description: "Learn how to troubleshoot your SDK setup."
sidebar_order: 9000
---

## General

<Expandable title="Why was my tag value truncated?">

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.

For example, a 200+ character tagged request:

`https://empowerplant.io/api/0/projects/ep/setup_form/?user_id=314159265358979323846264338327&tracking_id=EasyAsABC123OrSimpleAsDoReMi&product_name=PlantToHumanTranslator&product_id=161803398874989484820458683436563811772030917980576`

The 200+ character request above will become truncated to:

`https://empowerplant.io/api/0/projects/ep/setup_form/?user_id=314159265358979323846264338327&tracking_id=EasyAsABC123OrSimpleAsDoReMi&product_name=PlantToHumanTranslator&product_id=1618033988749894848`

</Expandable>

## Profiling

<Expandable title="Why am I not seeing any profiling data?">

If you don't see any profiling data in [sentry.io](https://sentry.io), you can try the following:

- Ensure that <PlatformLink to="/tracing/">Tracing is enabled</PlatformLink>.
- Ensure that the automatic instrumentation is sending performance data to Sentry by going to the **Performance** page
in [sentry.io](https://sentry.io).
- If the automatic instrumentation is not sending performance data, try using <PlatformLink
to="/tracing/instrumentation/custom-instrumentation">custom instrumentation</PlatformLink>.
- Enable <PlatformLink to="/configuration/options/#debug">debug mode</PlatformLink> in the SDK and check the logs.

### Limitations

Profiles for multi-threaded servers like `puma` might not capture frames correctly when async I/O is happening. This
is a limitation of `stackprof`.
</Expandable>

## Crons

<PlatformContent includePath="crons/troubleshooting" />

<Expandable title="Why aren't recurring job errors showing up on my monitor details page?">

You may not have <PlatformLink to="/crons/#connecting-errors-to-cron-monitors">linked errors to your monitor</PlatformLink>.

</Expandable>

<Expandable title="Why am I not receiving alerts when my monitor fails?">

You may not have <PlatformLink to="/crons/#alerts">set up alerts for your monitor</PlatformLink>.

</Expandable>

<Expandable title="What is the crons data retention policy for check-ins?">

Our current data retention policy is 90 days.

</Expandable>

<Expandable title="Do you support a monitor schedule with a six-field crontab expression?">

Currently, we only support crontab expressions with five fields.

</Expandable>
8 changes: 8 additions & 0 deletions redirects.js
Original file line number Diff line number Diff line change
Expand Up @@ -964,6 +964,14 @@ const userDocsRedirects = [
source: '/product/explore/feature-flags/:path*',
destination: '/product/issues/issue-details/feature-flags/:path*',
},
{
source: '/platforms/ruby/guides/:guide/:productfeature/troubleshooting/:path*',
destination: '/platforms/ruby/guides/:guide/troubleshooting/:path*',
},
{
source: '/platforms/ruby/:productfeature/troubleshooting/:path*',
destination: '/platforms/ruby/troubleshooting/:path*',
},
];

/**
Expand Down
Loading