Skip to content
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

feat: restructure docs #1046

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open
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
8 changes: 4 additions & 4 deletions data/docs/frontend-and-mobile-monitoring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,25 @@ title: Monitor your Frontend web and mobile applications

<DocCard
title="📄️ Swift UI"
description="Send events from you Swift iOS Mobile App to SigNoz."
description="Send events from your Swift iOS Mobile App to SigNoz."
href="/docs/instrumentation/mobile-instrumentation/swiftUi"
/>

<DocCard
title="📄️ Java"
description="Send events from you Java Android Mobile App to SigNoz."
description="Send events from your Java Android Mobile App to SigNoz."
href="/docs/instrumentation/mobile-instrumentation/java"
/>

<DocCard
title="📄️ Kotlin"
description="Send events from you Kotlin Android Mobile App to SigNoz."
description="Send events from your Kotlin Android Mobile App to SigNoz."
href="/docs/instrumentation/mobile-instrumentation/kotlin"
/>

<DocCard
title="📄️ Flutter"
description="Send events from you Flutter Android/iOS Mobile App to SigNoz."
description="Send events from your Flutter Android/iOS Mobile App to SigNoz."
href="/docs/instrumentation/mobile-instrumentation/flutter"
/>

Expand Down
20 changes: 10 additions & 10 deletions data/docs/instrumentation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,61 +10,61 @@ To instrument your applications and send data to SigNoz, follow the instructions

<DocCard
title="📄️ Python"
description="Send events from you Python application to SigNoz."
description="Send events from your Python application to SigNoz."
href="/docs/instrumentation/python"
/>

<DocCard
title="📄️ Java"
description="Send events from you Java application to SigNoz."
description="Send events from your Java application to SigNoz."
href="/docs/instrumentation/java"
/>

<DocCard
title="📄️ Javascript"
description="Send events from you Javascript application to SigNoz."
description="Send events from your Javascript application to SigNoz."
href="/docs/instrumentation/javascript"
/>

<DocCard
title="📄️ Golang (Go)"
description="Send events from you Golang (Go) application to SigNoz."
description="Send events from your Golang (Go) application to SigNoz."
href="/docs/instrumentation/golang"
/>

<DocCard
title="📄️ PHP"
description="Send events from you PHP application to SigNoz."
description="Send events from your PHP application to SigNoz."
href="/docs/instrumentation/php"
/>

<DocCard
title="📄️ .NET"
description="Send events from you .NET application to SigNoz."
description="Send events from your .NET application to SigNoz."
href="/docs/instrumentation/dotnet"
/>

<DocCard
title="📄️ Ruby on Rails"
description="Send events from you Ruby on Rails application to SigNoz."
description="Send events from your Ruby on Rails application to SigNoz."
href="/docs/instrumentation/ruby-on-rails"
/>

<DocCard
title="📄️ Elixir"
description="Send events from you Elixir application to SigNoz."
description="Send events from your Elixir application to SigNoz."
href="/docs/instrumentation/elixir"
/>

<DocCard
title="📄️ Rust"
description="Send events from you Rust application to SigNoz."
description="Send events from your Rust application to SigNoz."
href="/docs/instrumentation/rust"
/>

<DocCard
title="📄️ Swift"
description="Send events from you Swift application to SigNoz."
description="Send events from your Swift application to SigNoz."
href="/docs/instrumentation/swift"
/>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@ title: Android/iOS App in Flutter Instrumentation
description: Instrument your Android/iOS application built with Flutter using OpenTelemetry and send data to SigNoz
---

import InstrumentationFAQ from '@/components/shared/instrumentation-faq.md'
{/* import InstrumentationFAQ from '@/components/shared/instrumentation-faq.md' */}

This document contains instructions on how to set up OpenTelemetry instrumentation in your Flutter applications and view your application traces in SigNoz.

{/*
This documentation contains instructions on how to set up OpenTelemetry(OTel) instrumentation in your Android/iOS mobile application built using Flutter. OpenTelemetry, also known as OTel for short, is an open-source observability framework that can help you generate and collect telemetry data - traces, metrics, and logs from your Flutter application.

Once the telemetry data is generated, you can configure an exporter to send the data to SigNoz for monitoring and visualization.
Expand All @@ -15,7 +18,7 @@ There are three major steps to using OpenTelemetry:

- Instrumenting your iOS application with OpenTelemetry
- Configuring the exporter to send data to SigNoz
- Validating the configuration to ensure that data is being sent as expected.
- Validating the configuration to ensure that data is being sent as expected. */}

<Admonition type="info">
The package which we are using here is [Unofficial](https://pub.dev/packages/opentelemetry) Implementation of OpenTelemetry Packages.
Expand All @@ -28,6 +31,9 @@ In this tutorial, we will instrument an Android/iOS Mobile application for trace

[Flutter](https://docs.flutter.dev/get-started/install)


<Tabs entityName="plans">
<TabItem value="cloud" label="SigNoz Cloud" default>
### Send traces directly to SigNoz cloud


Expand Down Expand Up @@ -62,12 +68,12 @@ Put the following in `main.dart` file.
```
final headers = {
//INGESTION KEY HERE VARIABLE
'signoz-ingestion-key': '<SIGNOZ_INGESTION_KEY>',
'signoz-ingestion-key': '<your-ingestion-key>',
};

final exporter = CollectorExporter(
//enter ingestion url here VARIABLE
Uri.parse('ingest.[REGION].signoz.cloud:<PORT>/v1/traces'),
Uri.parse('ingest.<region>.signoz.cloud:443/v1/traces'),
headers: headers,
);

Expand All @@ -76,7 +82,7 @@ final headers = {
final provider = TracerProviderBase(
processors: [processor],
//enter service name here VARIABLE
resource: Resource( [Attribute.fromString("service.name", "<SERVICE_NAME>")]),
resource: Resource( [Attribute.fromString("service.name", "<service_name>")]),
);

registerGlobalTracerProvider(provider);
Expand Down Expand Up @@ -120,27 +126,9 @@ final headers = {

```

Ensure to replace `<SIGNOZ_INGESTION_KEY>`, `<PORT>`, and `<REGION>` with your actual SigNoz ingestion key, Port, and region, respectively.

You can find your Ingestion Key in the following places:
- mail which you recieved from SigNoz after signing up.
- inside settings on SigNoz dashboard

Depending on the choice of your region for SigNoz cloud, the ingest endpoint will vary according to this table.

| Region | Endpoint |
| --- | --- |
| US | ingest.us.signoz.cloud:443/v1/traces |
| IN | ingest.in.signoz.cloud:443/v1/traces |
| EU | ingest.eu.signoz.cloud:443/v1/traces |

These are the variables you need to replace :

| Placeholder | Description |
|----------------------------|---------------------------------------------|
| `<SIGNOZ_INGESTION_KEY>` | Your SigNoz ingestion key |
| `<PORT>` | Port (default: 443) |
| `<REGION>` | Region for SigNoz ingestion URL |
- Set the `<region>` to match your SigNoz Cloud [region](https://signoz.io/docs/ingestion/signoz-cloud/overview/#endpoint)
- Replace `<your-ingestion-key>` with your SigNoz [ingestion key](https://signoz.io/docs/ingestion/signoz-cloud/keys/).
- `<service_name>` is name of your service

**Step 3: Send Telemetry data to SigNoz**

Expand All @@ -153,3 +141,5 @@ _createSpan()
**Step 4: Run app**

Run your application from Android Studio to see the output & you can verify the sent span in SigNoz .
</TabItem>
</Tabs>
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@ title: Android App in Java Instrumentation
description: Instrument your Android application built with Java using OpenTelemetry and send data to SigNoz
---

import InstrumentationFAQ from '@/components/shared/instrumentation-faq.md'
{/* import InstrumentationFAQ from '@/components/shared/instrumentation-faq.md' */}

This documentation contains instructions on how to set up OpenTelemetry(OTel) instrumentation in your Android mobile application built using Java. OpenTelemetry, also known as OTel for short, is an open-source observability framework that can help you generate and collect telemetry data - traces, metrics, and logs from your Java application.
This document contains instructions on how to set up OpenTelemetry instrumentation in your Android Mobile applications built using Java and view your application traces in SigNoz.


{/* This documentation contains instructions on how to set up OpenTelemetry(OTel) instrumentation in your Android mobile application built using Java. OpenTelemetry, also known as OTel for short, is an open-source observability framework that can help you generate and collect telemetry data - traces, metrics, and logs from your Java application.

Once the telemetry data is generated, you can configure an exporter to send the data to SigNoz for monitoring and visualization.

Expand All @@ -17,12 +20,14 @@ There are three major steps to using OpenTelemetry:
- Configuring the exporter to send data to SigNoz
- Validating the configuration to ensure that data is being sent as expected.

In this tutorial, we will instrument a Java Mobile application (Android) for traces and send it to SigNoz.
In this tutorial, we will instrument a Java Mobile application (Android) for traces and send it to SigNoz. */}

## Requirements

Java 8 or higher

<Tabs entityName="plans">
<TabItem value="cloud" label="SigNoz Cloud" default>
### Send traces directly to SigNoz cloud

<Admonition type="info">
Expand Down Expand Up @@ -54,7 +59,7 @@ Create a file named `network_security_config.xml` in the `app/res/xml` directory
<?xml version="1.0" encoding="utf-8"?>
<network-security-config>
<domain-config cleartextTrafficPermitted="true">
<domain includeSubdomains="true">ingest.[REGION].signoz.cloud</domain>
<domain includeSubdomains="true">ingest.<region>.signoz.cloud</domain>
</domain-config>
</network-security-config>
```
Expand Down Expand Up @@ -103,8 +108,8 @@ public class OpenTelemetryUtil {
Resource otelResource = Resource.getDefault().merge(
Resource.create(
Attributes.of(
ResourceAttributes.SERVICE_NAME, "<SERVICE_NAME>",
ResourceAttributes.HOST_NAME, "<SERVICE_NAME>"
ResourceAttributes.SERVICE_NAME, "<service_name>",
ResourceAttributes.HOST_NAME, "<service_name>"
)
)
);
Expand All @@ -113,8 +118,8 @@ public class OpenTelemetryUtil {
.addSpanProcessor(SimpleSpanProcessor.create(LoggingSpanExporter.create()))
.addSpanProcessor(BatchSpanProcessor.builder(
OtlpGrpcSpanExporter.builder()
.setEndpoint("ingest.[REGION].signoz.cloud:<PORT>/v1/traces")
.addHeader("signoz-ingestion-key", "<SIGNOZ_INGESTION_KEY>")
.setEndpoint("ingest.<region>.signoz.cloud:443/v1/traces")
.addHeader("signoz-ingestion-key", "<your-ingestion-key>")
.build()).build()
)
.setResource(otelResource)
Expand All @@ -136,30 +141,9 @@ public class OpenTelemetryUtil {
}
```

Replace `<SERVICE_NAME>` with the name of app, you will see this name in SigNoz Services section.

Ensure to replace `<SIGNOZ_INGESTION_KEY>`, `<PORT>`, and `<REGION>` with your actual SigNoz ingestion key, Port, and Region, respectively.

You can find your Ingestion Key in the following places:
- mail which you recieved from SigNoz after signing up.
- inside settings on SigNoz dashboard

Depending on the choice of your region for SigNoz cloud, the ingest endpoint will vary according to this table.

| Region | Endpoint |
| --- | --- |
| US | ingest.us.signoz.cloud:443/v1/traces |
| IN | ingest.in.signoz.cloud:443/v1/traces |
| EU | ingest.eu.signoz.cloud:443/v1/traces |


These are the variables you need to replace :

| Placeholder | Description |
|----------------------------|---------------------------------------------|
| `<SIGNOZ_INGESTION_KEY>` | Your SigNoz ingestion key |
| `<PORT>` | Port (default: 443) |
| `<REGION>` | Region for SigNoz ingestion url |
- Set the `<region>` to match your SigNoz Cloud [region](https://signoz.io/docs/ingestion/signoz-cloud/overview/#endpoint)
- Replace `<your-ingestion-key>` with your SigNoz [ingestion key](https://signoz.io/docs/ingestion/signoz-cloud/keys/).
- `<service_name>` is name of your service

Inside MainActivity.java file, initialize the util

Expand Down Expand Up @@ -222,3 +206,5 @@ Call the above functions to add spans.
**Step 4: Run app**

Run your application from Android Studio to see the output & you can verify the sent span in SigNoz .
</TabItem>
</Tabs>
Loading