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

Commit

Permalink
Merge pull request #1760 from jaikanthjay46/jk/traces
Browse files Browse the repository at this point in the history
feat(tracing): add tracing link docs
  • Loading branch information
Calm-Rock authored Jun 12, 2024
2 parents 8881a6a + bdd854b commit ee90068
Show file tree
Hide file tree
Showing 5 changed files with 234 additions and 1 deletion.
49 changes: 48 additions & 1 deletion docs/azure-monitoring/aks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: aks
title: AKS Metrics & Logging
title: AKS Logging, Metrics & Tracing
---

## Overview
Expand All @@ -21,9 +21,56 @@ This setup is similar to the central collector but with a different function.
helm repo add signoz <https://charts.signoz.io>
helm install -n signoz --create-namespace kubelet-otel signoz/k8s-infra \\
--set signozApiKey=<ingestionKey> --set otelCollectorEndpoint="ingest.<region>.signoz.cloud:443" --set otelInsecure=false
```
This should start sending logs and metrics to SigNoz.


## Tracing

### eBPF Tracing

There are solution to collect metrics and traces without modifying the application code. These solutions come under the category of eBPF Tracing. These solutions are relatively new and are still in the early stages of development.

However, there are some open source projects that export metrics and traces to OpenTelemetry.
- [Pixie](https://github.com/pixie-io/pixie)
- [Hubble](https://github.com/cilium/hubble)
- [OpenTelemetry eBPF](https://github.com/open-telemetry/opentelemetry-network)

For example, Pixie can be configured by following the instructions in the respective repositories.
[Pixie OpenTelemetry Tutorial](https://docs.px.dev/tutorials/integrations/otel/)

```endpoint=px.otel.Endpoint(
url='otel-collector.kubelet-otel.svc.cluster.local:4317',
insecure=True
),
```

:::note
These solutions may not be suitable for all use cases, and are still may not be production-ready. It is recommended to evaluate solutions and choose the one that best fits your needs.
:::

### Application-Level Tracing

For application-level tracing, you can use the OpenTelemetry SDKs integrated with your application. These SDKs will automatically collect and forward traces to the Central Collector.

Please refer to our [SigNoz Tutorials](../../instrumentation/) or [Blog](https://signoz.io/blog/) to find information on how to instrument your application like Spring, FastAPI, NextJS, Langchain, Node.js, Flask, Django, etc.

```bash
# Node.js example
npm install @opentelemetry/api
npm install @opentelemetry/auto-instrumentations-node
npm install @opentelemetry/exporter-trace-otlp-http
```

### Configure the OpenTelemetry SDK

```bash
# Set env vars or config file
export OTEL_EXPORTER_OTLP_ENDPOINT="http://otel-collector.kubelet-otel.svc.cluster.local:4318/"
```

For application-level traces and metrics, configure your application to use the kube-dns name of the [Central Collector](../bootstrapping/collector-setup) you set up earlier.

## Troubleshooting

If you encounter any issues while setting up logging and metrics for your AKS cluster, follow these troubleshooting steps:
Expand Down
57 changes: 57 additions & 0 deletions docs/azure-monitoring/app-service/appsvc-tracing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
id: tracing
title: App Service Tracing
---

## QuickStart

To get started with monitoring your Azure App Service, we recommend using OpenTelemetry (Otel) SDKs to instrument your application. These SDKs will allow you to collect and forward metrics and traces to a Central Collector.

### Installing the OpenTelemetry SDK

Please refer to our [SigNoz Tutorials](../../../instrumentation/) or [Blog](https://signoz.io/blog/) to find information on how to instrument your application like Spring, FastAPI, NextJS, Langchain, Node.js, Flask, Django, etc. with OpenTelemetry.


```bash
# Node.js example
npm install @opentelemetry/api
npm install @opentelemetry/auto-instrumentations-node
npm install @opentelemetry/exporter-trace-otlp-http
```

### Configure the OpenTelemetry SDK

```bash
# Set env vars or config file
export OTEL_EXPORTER_OTLP_ENDPOINT="http://<Your-Central-Collector-DNS>:4318/"
```

For application-level traces and metrics, configure your application to use the DNS name of the [Central Collector](../../bootstrapping/collector-setup) you set up earlier. This Central Collector will automatically forward the collected data to SigNoz.


## Overview

Unified monitoring of your Azure App Service involves capturing application-level metrics and traces to provide comprehensive insights into your application's performance and resource utilization. For more detailed information on the unified monitoring in Azure, please refer to the [Azure Monitoring Strategy](../../bootstrapping/strategy).


## Prerequisites

Before you proceed, ensure the following prerequisites are met:

1. **Azure Subscription & App Service**: You need an active Azure subscription with a running Azure App Service instance.
2. **Central Collector Setup**: Make sure you have set up the Central Collector with the Azure Monitor exporter. If you haven't completed this setup, follow the instructions in the [Central Collector Setup](../../bootstrapping/collector-setup).



## Troubleshooting

If you encounter any issues while setting up monitoring for your Azure App Service, here are a few troubleshooting steps to help you resolve common problems:

1. **OpenTelemetry Collector Configuration**:
- Verify that the OpenTelemetry Collector is running.
- Ensure it is properly configured with the OLTP HTTP receiver.

2. **Azure App Service Accessibility**:
- Confirm that your Azure App Service instance is up and accessible.

By following this guide, you should be able to monitor your Azure App Service's traces with SigNoz effectively, gaining valuable insights into your application's performance and resource utilization.
57 changes: 57 additions & 0 deletions docs/azure-monitoring/az-container-apps/az-container-tracing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
id: tracing
title: Container App Tracing
---

## QuickStart

To get started with monitoring your Azure Container App, we recommend using OpenTelemetry (Otel) SDKs to instrument your application. These SDKs will allow you to collect and forward metrics and traces to a Central Collector.

### Installing the OpenTelemetry SDK

Please refer to our [SigNoz Tutorials](../../../instrumentation/) or [Blog](https://signoz.io/blog/) to find information on how to instrument your application like Spring, FastAPI, NextJS, Langchain, Node.js, Flask, Django, etc. with OpenTelemetry.


```bash
# Node.js example
npm install @opentelemetry/api
npm install @opentelemetry/auto-instrumentations-node
npm install @opentelemetry/exporter-trace-otlp-http
```

### Configure the OpenTelemetry SDK

```bash
# Set env vars or config file
export OTEL_EXPORTER_OTLP_ENDPOINT="http://<Your-Central-Collector-DNS>:4318/"
```

For application-level traces and metrics, configure your application to use the DNS name of the [Central Collector](../../bootstrapping/collector-setup) you set up earlier. This Central Collector will automatically forward the collected data to SigNoz.


## Overview

Unified monitoring of your Azure Container App involves capturing application-level metrics and traces to provide comprehensive insights into your application's performance and resource utilization. For more detailed information on the unified monitoring in Azure, please refer to the [Azure Monitoring Strategy](../../bootstrapping/strategy).


## Prerequisites

Before you proceed, ensure the following prerequisites are met:

1. **Azure Subscription & Container App**: You need an active Azure subscription with a running Azure Container App instance.
2. **Central Collector Setup**: Make sure you have set up the Central Collector with the Azure Monitor exporter. If you haven't completed this setup, follow the instructions in the [Central Collector Setup](../../bootstrapping/collector-setup).



## Troubleshooting

If you encounter any issues while setting up monitoring for your Azure Container App, here are a few troubleshooting steps to help you resolve common problems:

1. **OpenTelemetry Collector Configuration**:
- Verify that the OpenTelemetry Collector is running.
- Ensure it is properly configured with the OLTP HTTP receiver.

2. **Azure Container App Accessibility**:
- Confirm that your Azure Container App instance is up and accessible.

By following this guide, you should be able to monitor your Azure Container App's traces with SigNoz effectively, gaining valuable insights into your application's performance and resource utilization.
57 changes: 57 additions & 0 deletions docs/azure-monitoring/az-fns/az-fns-tracing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
id: tracing
title: Azure Function Tracing
---

## QuickStart

To get started with monitoring your Azure Function App, we recommend using OpenTelemetry (Otel) SDKs to instrument your application. These SDKs will allow you to collect and forward metrics and traces to a Central Collector.

### Installing the OpenTelemetry SDK

Please refer to our [SigNoz Tutorials](../../../instrumentation/) or [Blog](https://signoz.io/blog/) to find information on how to instrument your application like Spring, FastAPI, NextJS, Langchain, Node.js, Flask, Django, etc. with OpenTelemetry.


```bash
# Node.js example
npm install @opentelemetry/api
npm install @opentelemetry/auto-instrumentations-node
npm install @opentelemetry/exporter-trace-otlp-http
```

### Configure the OpenTelemetry SDK

```bash
# Set env vars or config file
export OTEL_EXPORTER_OTLP_ENDPOINT="http://<Your-Central-Collector-DNS>:4318/"
```

For application-level traces and metrics, configure your application to use the DNS name of the [Central Collector](../../bootstrapping/collector-setup) you set up earlier. This Central Collector will automatically forward the collected data to SigNoz.


## Overview

Unified monitoring of your Azure Function App involves capturing application-level metrics and traces to provide comprehensive insights into your application's performance and resource utilization. For more detailed information on the unified monitoring in Azure, please refer to the [Azure Monitoring Strategy](../../bootstrapping/strategy).


## Prerequisites

Before you proceed, ensure the following prerequisites are met:

1. **Azure Subscription & Container App**: You need an active Azure subscription with a running Azure Function App instance.
2. **Central Collector Setup**: Make sure you have set up the Central Collector with the Azure Monitor exporter. If you haven't completed this setup, follow the instructions in the [Central Collector Setup](../../bootstrapping/collector-setup).



## Troubleshooting

If you encounter any issues while setting up monitoring for your Azure Function App, here are a few troubleshooting steps to help you resolve common problems:

1. **OpenTelemetry Collector Configuration**:
- Verify that the OpenTelemetry Collector is running.
- Ensure it is properly configured with the OLTP HTTP receiver.

2. **Azure Function App Accessibility**:
- Confirm that your Azure Function App instance is up and accessible.

By following this guide, you should be able to monitor your Azure Function App's traces with SigNoz effectively, gaining valuable insights into your application's performance and resource utilization.
15 changes: 15 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -790,6 +790,11 @@ module.exports = {
type: 'doc',
id: 'azure-monitoring/app-service/logging',
label: 'Logging',
},
{
type: 'doc',
id: 'azure-monitoring/app-service/tracing',
label: 'Tracing',
}
]
},
Expand All @@ -816,6 +821,11 @@ module.exports = {
type: 'doc',
id: 'azure-monitoring/az-fns/logging',
label: 'Logging',
},
{
type: 'doc',
id: 'azure-monitoring/az-fns/tracing',
label: 'Tracing',
}
]
},
Expand All @@ -837,6 +847,11 @@ module.exports = {
type: 'doc',
id: 'azure-monitoring/az-container-apps/logging',
label: 'Logging',
},
{
type: 'doc',
id: 'azure-monitoring/az-container-apps/tracing',
label: 'Tracing',
}
]
},
Expand Down

0 comments on commit ee90068

Please sign in to comment.