forked from SigNoz/signoz
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: added frontend for newly addded flows (SigNoz#4151)
* feat: added frontend for newly addded flows * chore: added content for flows * chore: updated content for dotnet docs * chore: updated go instrumentation and http logs content * fix: removed console log and return true * fix: quickstart by default and cloudwatch logs * fix: removed console log
- Loading branch information
Showing
64 changed files
with
2,458 additions
and
11 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions
24
...Modules/APM/Dotnet/md-docs/Kubernetes/dotnet-kubernetes-installOtelCollector.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
## Install otel-collector in your Kubernetes infra | ||
| ||
|
||
Add the SigNoz Helm Chart repository | ||
```bash | ||
helm repo add signoz https://charts.signoz.io | ||
``` | ||
| ||
|
||
If the chart is already present, update the chart to the latest using: | ||
```bash | ||
helm repo update | ||
``` | ||
| ||
|
||
Install the Kubernetes Infrastructure chart provided by SigNoz | ||
```bash | ||
helm install my-release signoz/k8s-infra \ | ||
--set otelCollectorEndpoint=ingest.{{REGION}}.signoz.cloud:443 \ | ||
--set otelInsecure=false \ | ||
--set signozApiKey={{SIGNOZ_INGESTION_KEY}} \ | ||
--set global.clusterName=<CLUSTER_NAME> | ||
``` | ||
- Replace `<CLUSTER_NAME>` with the name of the Kubernetes cluster or a unique identifier of the cluster. |
65 changes: 65 additions & 0 deletions
65
...odules/APM/Dotnet/md-docs/Kubernetes/dotnet-kubernetes-instrumentApplication.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
After setting up the Otel collector agent, follow the steps below to instrument your .NET Application | ||
| ||
| ||
|
||
### Step 1: Install OpenTelemetry Dependencies | ||
Install the following dependencies in your application. | ||
|
||
```bash | ||
dotnet add package OpenTelemetry | ||
dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol | ||
dotnet add package OpenTelemetry.Extensions.Hosting | ||
dotnet add package OpenTelemetry.Instrumentation.Runtime | ||
dotnet add package OpenTelemetry.Instrumentation.AspNetCore | ||
dotnet add package OpenTelemetry.AutoInstrumentation | ||
``` | ||
|
||
| ||
|
||
### Step 2: Adding OpenTelemetry as a service and configuring exporter options | ||
|
||
In your `Program.cs` file, add OpenTelemetry as a service. Here, we are configuring these variables: | ||
|
||
`serviceName` - It is the name of your service. | ||
|
||
`otlpOptions.Endpoint` - It is the endpoint for your OTel Collector agent. | ||
|
||
| ||
|
||
Here’s a sample `Program.cs` file with the configured variables: | ||
|
||
```bash | ||
using System.Diagnostics; | ||
using OpenTelemetry.Exporter; | ||
using OpenTelemetry.Resources; | ||
using OpenTelemetry.Trace; | ||
|
||
var builder = WebApplication.CreateBuilder(args); | ||
|
||
// Configure OpenTelemetry with tracing and auto-start. | ||
builder.Services.AddOpenTelemetry() | ||
.ConfigureResource(resource => | ||
resource.AddService(serviceName: "{{MYAPP}}")) | ||
.WithTracing(tracing => tracing | ||
.AddAspNetCoreInstrumentation() | ||
.AddOtlpExporter(otlpOptions => | ||
{ | ||
otlpOptions.Endpoint = new Uri("http://localhost:4317"); | ||
|
||
otlpOptions.Protocol = OtlpExportProtocol.Grpc; | ||
})); | ||
|
||
var app = builder.Build(); | ||
|
||
//The index route ("/") is set up to write out the OpenTelemetry trace information on the response: | ||
app.MapGet("/", () => $"Hello World! OpenTelemetry Trace: {Activity.Current?.Id}"); | ||
|
||
app.Run(); | ||
``` | ||
|
||
The OpenTelemetry.Exporter.Options get or set the target to which the exporter is going to send traces. Here, we’re configuring it to send traces to the OTel Collector agent. The target must be a valid Uri with the scheme (http or https) and host and may contain a port and a path. | ||
|
||
This is done by configuring an OpenTelemetry [TracerProvider](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/trace/customizing-the-sdk#readme) using extension methods and setting it to auto-start when the host is started. | ||
|
||
|
||
|
10 changes: 10 additions & 0 deletions
10
...ainer/Modules/APM/Dotnet/md-docs/Kubernetes/dotnet-kubernetes-runApplication.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
| ||
|
||
To run your .NET application, use the below command : | ||
|
||
```bash | ||
dotnet build | ||
dotnet run | ||
``` | ||
|
||
Once you run your .NET application, interact with your application to generate some load and see your application in the SigNoz UI. |
71 changes: 71 additions & 0 deletions
71
...ocs/LinuxAMD64/QuickStart/dotnet-linuxamd64-quickStart-instrumentApplication.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
|
||
### Step 1: Install OpenTelemetry Dependencies | ||
Dependencies related to OpenTelemetry exporter and SDK have to be installed first. | ||
|
||
Run the below commands after navigating to the application source folder: | ||
```bash | ||
dotnet add package OpenTelemetry | ||
dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol | ||
dotnet add package OpenTelemetry.Extensions.Hosting | ||
dotnet add package OpenTelemetry.Instrumentation.Runtime | ||
dotnet add package OpenTelemetry.Instrumentation.AspNetCore | ||
dotnet add package OpenTelemetry.AutoInstrumentation | ||
``` | ||
|
||
| ||
|
||
### Step 2: Adding OpenTelemetry as a service and configuring exporter options | ||
|
||
In your `Program.cs` file, add OpenTelemetry as a service. Here, we are configuring these variables: | ||
|
||
`serviceName` - It is the name of your service. | ||
|
||
`otlpOptions.Endpoint` - It is the endpoint for your OTel Collector agent. | ||
|
||
| ||
|
||
Here’s a sample `Program.cs` file with the configured variables: | ||
|
||
```bash | ||
using System.Diagnostics; | ||
using OpenTelemetry.Exporter; | ||
using OpenTelemetry.Resources; | ||
using OpenTelemetry.Trace; | ||
|
||
var builder = WebApplication.CreateBuilder(args); | ||
|
||
// Configure OpenTelemetry with tracing and auto-start. | ||
builder.Services.AddOpenTelemetry() | ||
.ConfigureResource(resource => | ||
resource.AddService(serviceName: "{{MYAPP}}")) | ||
.WithTracing(tracing => tracing | ||
.AddAspNetCoreInstrumentation() | ||
.AddOtlpExporter(otlpOptions => | ||
{ | ||
//sigNoz Cloud Endpoint | ||
otlpOptions.Endpoint = new Uri("https://ingest.{{REGION}}.signoz.cloud:443"); | ||
|
||
otlpOptions.Protocol = OtlpExportProtocol.Grpc; | ||
|
||
//SigNoz Cloud account Ingestion key | ||
string headerKey = "signoz-access-token"; | ||
string headerValue = "{{SIGNOZ_INGESTION_KEY}}"; | ||
|
||
string formattedHeader = $"{headerKey}={headerValue}"; | ||
otlpOptions.Headers = formattedHeader; | ||
})); | ||
|
||
var app = builder.Build(); | ||
|
||
//The index route ("/") is set up to write out the OpenTelemetry trace information on the response: | ||
app.MapGet("/", () => $"Hello World! OpenTelemetry Trace: {Activity.Current?.Id}"); | ||
|
||
app.Run(); | ||
``` | ||
|
||
| ||
|
||
|
||
The OpenTelemetry.Exporter.Options get or set the target to which the exporter is going to send traces. Here, we’re configuring it to send traces to the OTel Collector agent. The target must be a valid Uri with the scheme (http or https) and host and may contain a port and a path. | ||
|
||
This is done by configuring an OpenTelemetry [TracerProvider](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/trace/customizing-the-sdk#readme) using extension methods and setting it to auto-start when the host is started. |
10 changes: 10 additions & 0 deletions
10
...et/md-docs/LinuxAMD64/QuickStart/dotnet-linuxamd64-quickStart-runApplication.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
| ||
To run your .NET application, use the below command : | ||
|
||
```bash | ||
dotnet build | ||
dotnet run | ||
``` | ||
|
||
Once you run your .NET application, interact with your application to generate some load and see your application in the SigNoz UI. | ||
|
98 changes: 98 additions & 0 deletions
98
...cs/LinuxAMD64/Recommended/dotnet-linuxamd64-recommended-installOtelCollector.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
## Setup OpenTelemetry Binary as an agent | ||
| ||
|
||
### Step 1: Download otel-collector tar.gz | ||
```bash | ||
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v0.79.0/otelcol-contrib_0.79.0_linux_amd64.tar.gz | ||
``` | ||
|
||
| ||
|
||
### Step 2: Extract otel-collector tar.gz to the `otelcol-contrib` folder | ||
```bash | ||
mkdir otelcol-contrib && tar xvzf otelcol-contrib_0.79.0_linux_amd64.tar.gz -C otelcol-contrib | ||
``` | ||
|
||
| ||
|
||
### Step 3: Create `config.yaml` in `otelcol-contrib` folder with the below content in it | ||
```bash | ||
receivers: | ||
otlp: | ||
protocols: | ||
grpc: | ||
endpoint: 0.0.0.0:4317 | ||
http: | ||
endpoint: 0.0.0.0:4318 | ||
hostmetrics: | ||
collection_interval: 60s | ||
scrapers: | ||
cpu: {} | ||
disk: {} | ||
load: {} | ||
filesystem: {} | ||
memory: {} | ||
network: {} | ||
paging: {} | ||
process: | ||
mute_process_name_error: true | ||
mute_process_exe_error: true | ||
mute_process_io_error: true | ||
processes: {} | ||
prometheus: | ||
config: | ||
global: | ||
scrape_interval: 60s | ||
scrape_configs: | ||
- job_name: otel-collector-binary | ||
static_configs: | ||
- targets: | ||
# - localhost:8888 | ||
processors: | ||
batch: | ||
send_batch_size: 1000 | ||
timeout: 10s | ||
# Ref: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/resourcedetectionprocessor/README.md | ||
resourcedetection: | ||
detectors: [env, system] # Before system detector, include ec2 for AWS, gcp for GCP and azure for Azure. | ||
# Using OTEL_RESOURCE_ATTRIBUTES envvar, env detector adds custom labels. | ||
timeout: 2s | ||
system: | ||
hostname_sources: [os] # alternatively, use [dns,os] for setting FQDN as host.name and os as fallback | ||
extensions: | ||
health_check: {} | ||
zpages: {} | ||
exporters: | ||
otlp: | ||
endpoint: "ingest.{{REGION}}.signoz.cloud:443" | ||
tls: | ||
insecure: false | ||
headers: | ||
"signoz-access-token": "{{SIGNOZ_INGESTION_KEY}}" | ||
logging: | ||
verbosity: normal | ||
service: | ||
telemetry: | ||
metrics: | ||
address: 0.0.0.0:8888 | ||
extensions: [health_check, zpages] | ||
pipelines: | ||
metrics: | ||
receivers: [otlp] | ||
processors: [batch] | ||
exporters: [otlp] | ||
metrics/internal: | ||
receivers: [prometheus, hostmetrics] | ||
processors: [resourcedetection, batch] | ||
exporters: [otlp] | ||
traces: | ||
receivers: [otlp] | ||
processors: [batch] | ||
exporters: [otlp] | ||
logs: | ||
receivers: [otlp] | ||
processors: [batch] | ||
exporters: [otlp] | ||
``` | ||
|
||
|
67 changes: 67 additions & 0 deletions
67
...s/LinuxAMD64/Recommended/dotnet-linuxamd64-recommended-instrumentApplication.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
After setting up the Otel collector agent, follow the steps below to instrument your .NET Application | ||
|
||
| ||
| ||
|
||
### Step 1: Install OpenTelemetry Dependencies | ||
Install the following dependencies in your application. | ||
|
||
```bash | ||
dotnet add package OpenTelemetry | ||
dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol | ||
dotnet add package OpenTelemetry.Extensions.Hosting | ||
dotnet add package OpenTelemetry.Instrumentation.Runtime | ||
dotnet add package OpenTelemetry.Instrumentation.AspNetCore | ||
dotnet add package OpenTelemetry.AutoInstrumentation | ||
``` | ||
|
||
| ||
|
||
### Step 2: Adding OpenTelemetry as a service and configuring exporter options | ||
|
||
In your `Program.cs` file, add OpenTelemetry as a service. Here, we are configuring these variables: | ||
|
||
`serviceName` - It is the name of your service. | ||
|
||
`otlpOptions.Endpoint` - It is the endpoint for your OTel Collector agent. | ||
|
||
| ||
|
||
Here’s a sample `Program.cs` file with the configured variables: | ||
|
||
```bash | ||
using System.Diagnostics; | ||
using OpenTelemetry.Exporter; | ||
using OpenTelemetry.Resources; | ||
using OpenTelemetry.Trace; | ||
|
||
var builder = WebApplication.CreateBuilder(args); | ||
|
||
// Configure OpenTelemetry with tracing and auto-start. | ||
builder.Services.AddOpenTelemetry() | ||
.ConfigureResource(resource => | ||
resource.AddService(serviceName: "{{MYAPP}}")) | ||
.WithTracing(tracing => tracing | ||
.AddAspNetCoreInstrumentation() | ||
.AddOtlpExporter(otlpOptions => | ||
{ | ||
otlpOptions.Endpoint = new Uri("http://localhost:4317"); | ||
|
||
otlpOptions.Protocol = OtlpExportProtocol.Grpc; | ||
})); | ||
|
||
var app = builder.Build(); | ||
|
||
//The index route ("/") is set up to write out the OpenTelemetry trace information on the response: | ||
app.MapGet("/", () => $"Hello World! OpenTelemetry Trace: {Activity.Current?.Id}"); | ||
|
||
app.Run(); | ||
``` | ||
| ||
|
||
The OpenTelemetry.Exporter.Options get or set the target to which the exporter is going to send traces. Here, we’re configuring it to send traces to the OTel Collector agent. The target must be a valid Uri with the scheme (http or https) and host and may contain a port and a path. | ||
|
||
This is done by configuring an OpenTelemetry [TracerProvider](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/trace/customizing-the-sdk#readme) using extension methods and setting it to auto-start when the host is started. | ||
|
||
|
||
|
18 changes: 18 additions & 0 deletions
18
.../md-docs/LinuxAMD64/Recommended/dotnet-linuxamd64-recommended-runApplication.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
| ||
Once you are done intrumenting your .NET application, you can run it using the below commands | ||
| ||
|
||
### Step 1: Run OTel Collector | ||
Run this command inside the `otelcol-contrib` directory that you created in the install Otel Collector step | ||
|
||
```bash | ||
./otelcol-contrib --config ./config.yaml | ||
``` | ||
|
||
| ||
|
||
### Step 2: Run your .NET application | ||
```bash | ||
dotnet build | ||
dotnet run | ||
``` |
Oops, something went wrong.