Skip to content
This repository was archived by the owner on Jun 17, 2024. It is now read-only.

Commit

Permalink
Merge pull request #1748 from SigNoz/cloud-troubleshooting
Browse files Browse the repository at this point in the history
feat: cloud troubleshooting
  • Loading branch information
Calm-Rock authored May 31, 2024
2 parents 15d89b6 + 28cc27d commit 1287e9e
Show file tree
Hide file tree
Showing 6 changed files with 144 additions and 0 deletions.
33 changes: 33 additions & 0 deletions docs/troubleshooting/signoz-cloud/general-troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: General SigNoz Cloud Troubleshooting
id: general-troubleshooting
---

These are instructions for general troubleshooting for SigNoz Cloud.



### Q. I can't find my Ingestion Key and Region. Where is it ?
To find the details about the Ingestion Key and Region, you can follow this flow in the SigNoz interface

**Settings --> Ingestion Settings**

The ingestion settings have all the Details about your Ingestion URL, Key and Region which you can directly copy and use in your config files.

### Q. How Do I cancel my subscription ?
Reach out to us on Intercom - the chatbox at the bottom right corner of your SigNoz Cloud interface.


### Q. I see a message that my account might be Rate limited ?
For SigNoz Cloud Trial Accounts you might get a message saying
`"You are sending data at more than 100 RPS, your ingestion may be rate limited. Please reach out to us via Intercom support."` To remove this rate limit, you need to upgrade your plan under the Billing Section of your SigNoz Cloud Interface and add your credit card.
<!-- Hyperlink to the Billing Troubleshooting or Doc-->

### Q. I need a Vendor Address for the payment to be approved.

You can use this Address - **SigNoz Inc - 2261 Market Street #4496, San Francisco, CA, 94114**

### Q. What is a DataSource ?
DataSource is the service, db or any instance which generates telemetry data (Traces, Logs and Metrics).


32 changes: 32 additions & 0 deletions docs/troubleshooting/signoz-cloud/logs-troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Logs SigNoz Cloud Troubleshooting
id: logs-troubleshooting
---

These are instructions for logs troubleshooting for SigNoz Cloud.

### Q. In java my mdc attributes are not visible in SigNoz

You can get your mdc attributes by using the [appender settings](https://signoz.io/docs/userguide/collecting_application_logs_otel_sdk_java#settings-for-appender-instrumentation-based-on-the-logging-library) and passing it as `-D<property>=<value>` format.

For example, for **logback** you can use `otel.instrumentation.logback-appender.experimental.capture-mdc-attributes=*` and for **log4j** you can use `otel.instrumentation.log4j-appender.experimental.capture-mdc-attributes=*`. Checkout [this documentation](`otel.instrumentation.log4j-appender.experimental.capture-mdc-attributes=*`) for more system properties.

### Q. I want to extract trace_id and span_id from my log line

You can extract these using the logs pipelines trace parser - documentation [here](https://signoz.io/docs/logs-pipelines/guides/trace/)

### Q.I want to extract a attribute from my log line

The best way to do this is using Logs Pipeline. You can follow these two Docs:
- [Logs Pipeline Introductions](https://signoz.io/docs/logs-pipelines/introduction/)
- [Parse JSON logs with Pipelines](https://signoz.io/docs/logs-pipelines/guides/json/)


### Q. I am sending logs but my logs are not visible on SigNoz

Check by adding a console exporter on application level if you are using SDK else on a local collector level.
Once the above is checked and if you are still facing issue then reach out to us on Intercom - the chatbox at the bottom right corner of your SigNoz Cloud interface.


### Q. How to increase the retention period of logs from x days to y days?
Reach out to us on Intercom - the chatbox at the bottom right corner of your SigNoz Cloud interface.
32 changes: 32 additions & 0 deletions docs/troubleshooting/signoz-cloud/metrics-troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Metrics SigNoz Cloud Troubleshooting
id: metrics-troubleshooting
---

### Q. I see an empty Dashboard, what should I do ?

Try changing the variable in Dashboard.
For example, if you're using the **[Kubernetes Pod Metrics - Overall](https://github.com/SigNoz/dashboards/blob/main/k8s-infra-metrics/kubernetes-pod-metrics-overall.json)** dashboard, you can select $node_name variable as **ALL** to see the data as shown in below image.

<figure data-zoomable align="center">
<img
src="/img/docs/troubleshooting/signoz-cloud/cloud-troubleshooting-metrics-1.webp"
alt="Select a variable to see Dashboard Values"
/>
<figcaption>
<i>
Selecting ALL as $node_name variable in Kubernetes Pod Metrics - Overall Dashboard
</i>
</figcaption>
</figure>


### Q. How to see metrics of a service ?
[Add a panel](https://signoz.io/docs/userguide/manage-panels/) in a Dashboard and you can see the metrics in dropdown.

<!-- This info will change -->
We are working on Metrics explorer which will allow viewing all metrics without using the Dashboards. This will be live soon!

### Q. I want to import Grafana Dashboards but the option is disabled for me.
<!-- This info will change -->
This functionality doesn't work at the moment so it's disabled.
9 changes: 9 additions & 0 deletions docs/troubleshooting/signoz-cloud/traces-troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Traces SigNoz Cloud Troubleshooting
id: traces-troubleshooting
---

These are instructions for traces troubleshooting for SigNoz Cloud.


We will be adding troubleshooting instructions here soon ... 🙂
38 changes: 38 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -995,6 +995,44 @@ module.exports = {
},
],
},
{
label: "Troubleshooting",
type: "category",
items:[
{
type: 'category',
label: 'SigNoz Cloud',
link: {
type: 'generated-index',
title: 'SigNoz Cloud',
description: 'Find the Troubleshooting instructions for SigNoz Cloud',
slug: '/signoz-cloud-troubleshooting',
},
items: [
{
id: "troubleshooting/signoz-cloud/general-troubleshooting",
type: "doc",
label: "General",
},
{
id: "troubleshooting/signoz-cloud/traces-troubleshooting",
type: "doc",
label: "Traces",
},
{
id: "troubleshooting/signoz-cloud/logs-troubleshooting",
type: "doc",
label: "Logs",
},
{
id: "troubleshooting/signoz-cloud/metrics-troubleshooting",
type: "doc",
label: "Metrics",
},
]
},
],
},
{
label: "FAQ",
type: "category",
Expand Down
Binary file not shown.

0 comments on commit 1287e9e

Please sign in to comment.