From d42bf50ddb44d1feb9b758009164801529b7b9bd Mon Sep 17 00:00:00 2001 From: Yunus M Date: Tue, 21 Nov 2023 20:01:14 +0530 Subject: [PATCH 1/7] fix: docs updated according to feedback (#4011) Co-authored-by: CheetoDa --- .../golang-kubernetes-installOtelCollector.md | 5 +- ...golang-kubernetes-instrumentApplication.md | 21 ++- .../golang-kubernetes-runApplication.md | 2 + ...xamd64-quickStart-instrumentApplication.md | 20 ++- ...ng-linuxamd64-quickStart-runApplication.md | 1 + ...xamd64-recommended-installOtelCollector.md | 7 +- ...amd64-recommended-instrumentApplication.md | 21 ++- ...g-linuxamd64-recommended-runApplication.md | 10 +- ...xarm64-quickStart-instrumentApplication.md | 20 ++- ...ng-linuxarm64-quickStart-runApplication.md | 1 + ...xarm64-recommended-installOtelCollector.md | 10 +- ...arm64-recommended-instrumentApplication.md | 21 ++- ...g-linuxarm64-recommended-runApplication.md | 10 +- ...samd64-quickStart-instrumentApplication.md | 20 ++- ...ng-macosamd64-quickStart-runApplication.md | 1 + ...samd64-recommended-installOtelCollector.md | 7 +- ...amd64-recommended-instrumentApplication.md | 21 ++- ...g-macosamd64-recommended-runApplication.md | 10 +- ...sarm64-quickStart-instrumentApplication.md | 20 ++- ...ng-macosarm64-quickStart-runApplication.md | 1 + ...sarm64-recommended-installOtelCollector.md | 8 +- ...arm64-recommended-instrumentApplication.md | 21 ++- ...g-macosarm64-recommended-runApplication.md | 10 +- .../jboss-kubernetes-installOtelCollector.md | 5 +- .../jboss-kubernetes-instrumentApplication.md | 4 +- .../jboss-kubernetes-runApplication.md | 6 + ...xamd64-quickStart-instrumentApplication.md | 2 + ...ss-linuxamd64-quickStart-runApplication.md | 7 +- ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 3 +- ...s-linuxamd64-recommended-runApplication.md | 12 +- ...xarm64-quickStart-instrumentApplication.md | 2 + ...ss-linuxarm64-quickStart-runApplication.md | 7 +- ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 3 +- ...s-linuxarm64-recommended-runApplication.md | 12 +- ...samd64-quickStart-instrumentApplication.md | 2 + ...ss-macosamd64-quickStart-runApplication.md | 7 +- ...samd64-recommended-installOtelCollector.md | 3 + ...amd64-recommended-instrumentApplication.md | 3 +- ...s-macosamd64-recommended-runApplication.md | 12 +- ...sarm64-quickStart-instrumentApplication.md | 2 + ...ss-macosarm64-quickStart-runApplication.md | 7 +- ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 3 +- ...s-macosarm64-recommended-runApplication.md | 12 +- .../others-kubernetes-installOtelCollector.md | 5 +- ...others-kubernetes-instrumentApplication.md | 4 +- .../others-kubernetes-runApplication.md | 7 + ...xamd64-quickStart-instrumentApplication.md | 1 + ...rs-linuxamd64-quickStart-runApplication.md | 2 + ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 3 +- ...s-linuxamd64-recommended-runApplication.md | 13 +- ...xarm64-quickStart-instrumentApplication.md | 1 + ...rs-linuxarm64-quickStart-runApplication.md | 2 + ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 3 +- ...s-linuxarm64-recommended-runApplication.md | 13 +- ...samd64-quickStart-instrumentApplication.md | 1 + ...rs-macosamd64-quickStart-runApplication.md | 2 + ...samd64-recommended-installOtelCollector.md | 3 + ...amd64-recommended-instrumentApplication.md | 3 +- ...s-macosamd64-recommended-runApplication.md | 13 +- ...sarm64-quickStart-instrumentApplication.md | 1 + ...rs-macosarm64-quickStart-runApplication.md | 2 + ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 3 +- ...s-macosarm64-recommended-runApplication.md | 11 +- ...ingBoot-kubernetes-installOtelCollector.md | 5 +- ...ngBoot-kubernetes-instrumentApplication.md | 4 +- .../springBoot-kubernetes-runApplication.md | 8 + ...xamd64-quickStart-instrumentApplication.md | 2 + ...ot-linuxamd64-quickStart-runApplication.md | 2 + ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 3 +- ...t-linuxamd64-recommended-runApplication.md | 14 +- ...xarm64-quickStart-instrumentApplication.md | 2 + ...ot-linuxarm64-quickStart-runApplication.md | 2 + ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 3 +- ...t-linuxarm64-recommended-runApplication.md | 14 +- ...samd64-quickStart-instrumentApplication.md | 2 + ...ot-macosamd64-quickStart-runApplication.md | 2 + ...samd64-recommended-installOtelCollector.md | 3 + ...amd64-recommended-instrumentApplication.md | 3 +- ...t-macosamd64-recommended-runApplication.md | 15 +- ...sarm64-quickStart-instrumentApplication.md | 2 + ...ot-macosarm64-quickStart-runApplication.md | 2 + ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 3 +- ...t-macosarm64-recommended-runApplication.md | 15 +- .../tomcat-kubernetes-installOtelCollector.md | 5 +- ...tomcat-kubernetes-instrumentApplication.md | 3 +- .../tomcat-kubernetes-runApplication.md | 14 +- ...xamd64-quickStart-instrumentApplication.md | 1 + ...at-linuxamd64-quickStart-runApplication.md | 10 +- ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 5 +- ...t-linuxamd64-recommended-runApplication.md | 14 +- ...xarm64-quickStart-instrumentApplication.md | 1 + ...at-linuxarm64-quickStart-runApplication.md | 10 +- ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 5 +- ...t-linuxarm64-recommended-runApplication.md | 14 +- ...samd64-quickStart-instrumentApplication.md | 1 + ...at-macosamd64-quickStart-runApplication.md | 10 +- ...samd64-recommended-installOtelCollector.md | 3 + ...amd64-recommended-instrumentApplication.md | 5 +- ...t-macosamd64-recommended-runApplication.md | 14 +- ...sarm64-quickStart-instrumentApplication.md | 1 + ...at-macosarm64-quickStart-runApplication.md | 10 +- ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 5 +- ...t-macosarm64-recommended-runApplication.md | 14 +- ...express-kubernetes-installOtelCollector.md | 5 +- ...xpress-kubernetes-instrumentApplication.md | 7 +- .../express-kubernetes-runApplication.md | 9 +- ...xamd64-quickStart-instrumentApplication.md | 2 + ...ss-linuxamd64-quickStart-runApplication.md | 8 +- ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 4 +- ...s-linuxamd64-recommended-runApplication.md | 16 +- ...xarm64-quickStart-instrumentApplication.md | 2 + ...ss-linuxarm64-quickStart-runApplication.md | 8 +- ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 4 +- ...s-linuxarm64-recommended-runApplication.md | 16 +- ...samd64-quickStart-instrumentApplication.md | 2 + ...ss-macosamd64-quickStart-runApplication.md | 8 +- ...samd64-recommended-installOtelCollector.md | 3 + ...amd64-recommended-instrumentApplication.md | 4 +- ...s-macosamd64-recommended-runApplication.md | 16 +- ...sarm64-quickStart-instrumentApplication.md | 2 + ...ss-macosarm64-quickStart-runApplication.md | 8 +- ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 4 +- ...s-macosarm64-recommended-runApplication.md | 16 +- .../nestjs-kubernetes-installOtelCollector.md | 5 +- ...nestjs-kubernetes-instrumentApplication.md | 8 +- .../nestjs-kubernetes-runApplication.md | 6 +- ...xamd64-quickStart-instrumentApplication.md | 5 + ...js-linuxamd64-quickStart-runApplication.md | 6 +- ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 8 +- ...s-linuxamd64-recommended-runApplication.md | 15 +- ...xarm64-quickStart-instrumentApplication.md | 5 + ...js-linuxarm64-quickStart-runApplication.md | 6 +- ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 8 +- ...s-linuxarm64-recommended-runApplication.md | 15 +- ...samd64-quickStart-instrumentApplication.md | 5 + ...js-macosamd64-quickStart-runApplication.md | 6 +- ...samd64-recommended-installOtelCollector.md | 3 + ...amd64-recommended-instrumentApplication.md | 8 +- ...s-macosamd64-recommended-runApplication.md | 15 +- ...sarm64-quickStart-instrumentApplication.md | 5 + ...js-macosarm64-quickStart-runApplication.md | 6 +- ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 8 +- ...s-macosarm64-recommended-runApplication.md | 15 +- .../nodejs-kubernetes-installOtelCollector.md | 5 +- ...nodejs-kubernetes-instrumentApplication.md | 6 +- .../nodejs-kubernetes-runApplication.md | 6 +- ...xamd64-quickStart-instrumentApplication.md | 3 + ...js-linuxamd64-quickStart-runApplication.md | 6 +- ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 7 +- ...s-linuxamd64-recommended-runApplication.md | 16 +- ...xarm64-quickStart-instrumentApplication.md | 3 + ...js-linuxarm64-quickStart-runApplication.md | 6 +- ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 7 +- ...s-linuxarm64-recommended-runApplication.md | 16 +- ...samd64-quickStart-instrumentApplication.md | 3 + ...js-macosamd64-quickStart-runApplication.md | 6 +- ...samd64-recommended-installOtelCollector.md | 160 +++++++++--------- ...amd64-recommended-instrumentApplication.md | 7 +- ...s-macosamd64-recommended-runApplication.md | 16 +- ...sarm64-quickStart-instrumentApplication.md | 3 + ...js-macosarm64-quickStart-runApplication.md | 6 +- ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 7 +- ...s-macosarm64-recommended-runApplication.md | 16 +- .../django-kubernetes-installOtelCollector.md | 5 +- ...django-kubernetes-instrumentApplication.md | 8 +- .../django-kubernetes-runApplication.md | 8 + ...xamd64-quickStart-instrumentApplication.md | 5 + ...go-linuxamd64-quickStart-runApplication.md | 6 + ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 8 +- ...o-linuxamd64-recommended-runApplication.md | 17 +- ...xarm64-quickStart-instrumentApplication.md | 5 + ...go-linuxarm64-quickStart-runApplication.md | 6 + ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 8 +- ...o-linuxarm64-recommended-runApplication.md | 17 +- ...samd64-quickStart-instrumentApplication.md | 5 + ...go-macosamd64-quickStart-runApplication.md | 6 + ...samd64-recommended-installOtelCollector.md | 3 + ...amd64-recommended-instrumentApplication.md | 8 +- ...o-macosamd64-recommended-runApplication.md | 17 +- ...sarm64-quickStart-instrumentApplication.md | 5 + ...go-macosarm64-quickStart-runApplication.md | 6 + ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 8 +- ...o-macosarm64-recommended-runApplication.md | 17 +- .../falcon-kubernetes-installOtelCollector.md | 5 +- ...falcon-kubernetes-instrumentApplication.md | 9 +- .../falcon-kubernetes-runApplication.md | 7 + ...xamd64-quickStart-instrumentApplication.md | 6 + ...on-linuxamd64-quickStart-runApplication.md | 7 + ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 9 +- ...n-linuxamd64-recommended-runApplication.md | 13 +- ...xarm64-quickStart-instrumentApplication.md | 6 + ...on-linuxarm64-quickStart-runApplication.md | 7 + ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 9 +- ...n-linuxarm64-recommended-runApplication.md | 13 +- ...samd64-quickStart-instrumentApplication.md | 6 + ...on-macosamd64-quickStart-runApplication.md | 7 + ...samd64-recommended-installOtelCollector.md | 3 + ...amd64-recommended-instrumentApplication.md | 9 +- ...n-macosamd64-recommended-runApplication.md | 13 +- ...sarm64-quickStart-instrumentApplication.md | 6 + ...on-macosarm64-quickStart-runApplication.md | 7 + ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 9 +- ...n-macosarm64-recommended-runApplication.md | 14 +- ...fastapi-kubernetes-installOtelCollector.md | 5 +- ...astapi-kubernetes-instrumentApplication.md | 10 +- .../fastapi-kubernetes-runApplication.md | 6 + ...xamd64-quickStart-instrumentApplication.md | 8 + ...pi-linuxamd64-quickStart-runApplication.md | 6 + ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 8 + ...i-linuxamd64-recommended-runApplication.md | 16 +- ...xarm64-quickStart-instrumentApplication.md | 8 + ...pi-linuxarm64-quickStart-runApplication.md | 8 +- ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 8 + ...i-linuxarm64-recommended-runApplication.md | 16 +- ...samd64-quickStart-instrumentApplication.md | 8 + ...pi-macosamd64-quickStart-runApplication.md | 6 + ...samd64-recommended-installOtelCollector.md | 3 + ...amd64-recommended-instrumentApplication.md | 8 + ...i-macosamd64-recommended-runApplication.md | 16 +- ...sarm64-quickStart-instrumentApplication.md | 8 + ...pi-macosarm64-quickStart-runApplication.md | 6 + ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 8 + ...i-macosarm64-recommended-runApplication.md | 16 +- .../flask-kubernetes-installOtelCollector.md | 5 +- .../flask-kubernetes-instrumentApplication.md | 10 +- .../flask-kubernetes-runApplication.md | 8 + ...xamd64-quickStart-instrumentApplication.md | 9 + ...sk-linuxamd64-quickStart-runApplication.md | 8 + ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 8 + ...k-linuxamd64-recommended-runApplication.md | 16 +- ...xarm64-quickStart-instrumentApplication.md | 9 + ...sk-linuxarm64-quickStart-runApplication.md | 8 + ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 8 + ...k-linuxarm64-recommended-runApplication.md | 16 +- ...samd64-quickStart-instrumentApplication.md | 9 + ...sk-macosamd64-quickStart-runApplication.md | 8 + ...samd64-recommended-installOtelCollector.md | 3 + ...amd64-recommended-instrumentApplication.md | 8 + ...k-macosamd64-recommended-runApplication.md | 16 +- ...sarm64-quickStart-instrumentApplication.md | 9 + ...sk-macosarm64-quickStart-runApplication.md | 8 + ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 8 + ...k-macosarm64-recommended-runApplication.md | 16 +- .../others-kubernetes-installOtelCollector.md | 5 +- ...others-kubernetes-instrumentApplication.md | 10 +- .../others-kubernetes-runApplication.md | 6 + ...xamd64-quickStart-instrumentApplication.md | 9 +- ...rs-linuxamd64-quickStart-runApplication.md | 6 + ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 5 + ...s-linuxamd64-recommended-runApplication.md | 12 +- ...xarm64-quickStart-instrumentApplication.md | 9 +- ...rs-linuxarm64-quickStart-runApplication.md | 6 + ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 7 +- ...s-linuxarm64-recommended-runApplication.md | 12 +- ...samd64-quickStart-instrumentApplication.md | 8 +- ...rs-macosamd64-quickStart-runApplication.md | 6 + ...samd64-recommended-installOtelCollector.md | 3 + ...amd64-recommended-instrumentApplication.md | 7 +- ...s-macosamd64-recommended-runApplication.md | 12 +- ...sarm64-quickStart-instrumentApplication.md | 8 +- ...rs-macosarm64-quickStart-runApplication.md | 6 + ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 7 +- ...s-macosarm64-recommended-runApplication.md | 12 +- .../ror-kubernetes-installOtelCollector.md | 5 +- .../ror-kubernetes-instrumentApplication.md | 7 +- ...xamd64-quickStart-instrumentApplication.md | 5 +- ...xamd64-recommended-installOtelCollector.md | 5 +- ...amd64-recommended-instrumentApplication.md | 9 +- ...r-linuxamd64-recommended-runApplication.md | 12 +- ...xarm64-quickStart-instrumentApplication.md | 4 + ...xarm64-recommended-installOtelCollector.md | 5 +- ...arm64-recommended-instrumentApplication.md | 9 +- ...r-linuxarm64-recommended-runApplication.md | 12 +- ...samd64-quickStart-instrumentApplication.md | 4 + ...samd64-recommended-installOtelCollector.md | 3 + ...amd64-recommended-instrumentApplication.md | 9 +- ...r-macosamd64-recommended-runApplication.md | 12 +- ...sarm64-quickStart-instrumentApplication.md | 4 + ...sarm64-recommended-installOtelCollector.md | 6 +- ...arm64-recommended-instrumentApplication.md | 9 +- ...r-macosarm64-recommended-runApplication.md | 12 +- .../md-docs/kubernetes-setupOtelCollector.md | 7 +- .../otherMetrics-configureReceiver.md | 2 +- .../otherMetrics-configureReceiver.md | 2 +- .../otherMetrics-configureReceiver.md | 2 +- .../otherMetrics-configureReceiver.md | 2 +- ...ionLogs-macosarm64-installOtelCollector.md | 1 + .../Docker/md-docs/docker-cloneRepository.md | 13 +- .../Docker/md-docs/docker-startContainers.md | 2 +- ...uentbit-macosarm64-installOtelCollector.md | 2 +- ...fluentd-macosarm64-installOtelCollector.md | 2 +- .../kubernetes-installOtelCollector.md | 10 +- .../logstash-linuxamd64-configureReceiver.md | 10 +- ...ogstash-linuxamd64-installOtelCollector.md | 10 +- ...ogstash-linuxamd64-restartOtelCollector.md | 9 +- .../logstash-linuxarm64-configureReceiver.md | 10 +- ...ogstash-linuxarm64-installOtelCollector.md | 8 +- ...ogstash-linuxarm64-restartOtelCollector.md | 9 +- .../logstash-macosamd64-configureReceiver.md | 10 +- ...ogstash-macosamd64-installOtelCollector.md | 9 +- ...ogstash-macosamd64-restartOtelCollector.md | 9 +- .../logstash-macosarm64-configureReceiver.md | 10 +- ...ogstash-macosarm64-installOtelCollector.md | 11 +- ...ogstash-macosarm64-restartOtelCollector.md | 9 +- ...syslogs-macosarm64-installOtelCollector.md | 2 +- 341 files changed, 2186 insertions(+), 489 deletions(-) diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/Kubernetes/golang-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/Kubernetes/golang-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/Kubernetes/golang-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/Kubernetes/golang-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/Kubernetes/golang-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/Kubernetes/golang-kubernetes-instrumentApplication.md index edf5710cf2..642da55e8b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/Kubernetes/golang-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/Kubernetes/golang-kubernetes-instrumentApplication.md @@ -1,7 +1,9 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Go Application +After setting up the Otel collector agent, follow the steps below to instrument your Go Application +  +  ### Step 1: Install OpenTelemetry Dependencies -Dependencies related to OpenTelemetry exporter and SDK have to be installed first +Dependencies related to OpenTelemetry exporter and SDK have to be installed first. Run the below commands after navigating to the application source folder: ```bash @@ -13,7 +15,9 @@ go get go.opentelemetry.io/otel \ go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc ``` -**Note:** Note that we are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +**Note:** We are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +  +  ### Step 2: Declare environment variables for configuring OpenTelemetry Declare the following global variables in **`main.go`** which we will use to configure OpenTelemetry: @@ -24,9 +28,10 @@ Declare the following global variables in **`main.go`** which we will use to con insecure = os.Getenv("INSECURE_MODE") ) ``` +  ### Step 3: Instrument your Go application -To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your `main.go` file. +To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your **`main.go`** file. ```bash @@ -85,9 +90,10 @@ To configure your application to send data we will need a function to initialize return exporter.Shutdown } ``` +  -### Step 4: Initialise the tracer in `main.go` -Modify the main function to initialise the tracer in main.go. Initiate the tracer at the very beginning of our main function. +### Step 4: Initialise the tracer in **`main.go`** +Modify the main function to initialise the tracer in **`main.go`**. Initiate the tracer at the very beginning of our main function. ```bash func main() { cleanup := initTracer() @@ -96,9 +102,10 @@ func main() { ...... } ``` +  ### Step 5: Add the OpenTelemetry Gin middleware -Configure Gin to use the middleware by adding the following lines in `main.go` +Configure Gin to use the middleware by adding the following lines in **`main.go`** ```bash import ( .... diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/Kubernetes/golang-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/Kubernetes/golang-kubernetes-runApplication.md index 6b12c13909..2be8b21aeb 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/Kubernetes/golang-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/Kubernetes/golang-kubernetes-runApplication.md @@ -1,3 +1,5 @@ +  + To run your Go Gin application, use the below command : ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/QuickStart/golang-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/QuickStart/golang-linuxamd64-quickStart-instrumentApplication.md index 7be1874b6d..642da55e8b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/QuickStart/golang-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/QuickStart/golang-linuxamd64-quickStart-instrumentApplication.md @@ -1,6 +1,9 @@ +After setting up the Otel collector agent, follow the steps below to instrument your Go Application +  +  ### Step 1: Install OpenTelemetry Dependencies -Dependencies related to OpenTelemetry exporter and SDK have to be installed first +Dependencies related to OpenTelemetry exporter and SDK have to be installed first. Run the below commands after navigating to the application source folder: ```bash @@ -12,7 +15,9 @@ go get go.opentelemetry.io/otel \ go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc ``` -**Note:** Note that we are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +**Note:** We are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +  +  ### Step 2: Declare environment variables for configuring OpenTelemetry Declare the following global variables in **`main.go`** which we will use to configure OpenTelemetry: @@ -23,9 +28,10 @@ Declare the following global variables in **`main.go`** which we will use to con insecure = os.Getenv("INSECURE_MODE") ) ``` +  ### Step 3: Instrument your Go application -To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your `main.go` file. +To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your **`main.go`** file. ```bash @@ -84,9 +90,10 @@ To configure your application to send data we will need a function to initialize return exporter.Shutdown } ``` +  -### Step 4: Initialise the tracer in `main.go` -Modify the main function to initialise the tracer in main.go. Initiate the tracer at the very beginning of our main function. +### Step 4: Initialise the tracer in **`main.go`** +Modify the main function to initialise the tracer in **`main.go`**. Initiate the tracer at the very beginning of our main function. ```bash func main() { cleanup := initTracer() @@ -95,9 +102,10 @@ func main() { ...... } ``` +  ### Step 5: Add the OpenTelemetry Gin middleware -Configure Gin to use the middleware by adding the following lines in `main.go` +Configure Gin to use the middleware by adding the following lines in **`main.go`** ```bash import ( .... diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/QuickStart/golang-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/QuickStart/golang-linuxamd64-quickStart-runApplication.md index 3d72dffe2e..c8952212f8 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/QuickStart/golang-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/QuickStart/golang-linuxamd64-quickStart-runApplication.md @@ -1,3 +1,4 @@ +  To run your Go Gin application, use the below command : ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/Recommended/golang-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/Recommended/golang-linuxamd64-recommended-installOtelCollector.md index 085baefc95..3fa9a2aa5b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/Recommended/golang-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/Recommended/golang-linuxamd64-recommended-installOtelCollector.md @@ -1,16 +1,19 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it +### Step 3: Create `config.yaml` in `otelcol-contrib` folder with the below content in it ```bash receivers: otlp: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/Recommended/golang-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/Recommended/golang-linuxamd64-recommended-instrumentApplication.md index edf5710cf2..642da55e8b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/Recommended/golang-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/Recommended/golang-linuxamd64-recommended-instrumentApplication.md @@ -1,7 +1,9 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Go Application +After setting up the Otel collector agent, follow the steps below to instrument your Go Application +  +  ### Step 1: Install OpenTelemetry Dependencies -Dependencies related to OpenTelemetry exporter and SDK have to be installed first +Dependencies related to OpenTelemetry exporter and SDK have to be installed first. Run the below commands after navigating to the application source folder: ```bash @@ -13,7 +15,9 @@ go get go.opentelemetry.io/otel \ go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc ``` -**Note:** Note that we are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +**Note:** We are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +  +  ### Step 2: Declare environment variables for configuring OpenTelemetry Declare the following global variables in **`main.go`** which we will use to configure OpenTelemetry: @@ -24,9 +28,10 @@ Declare the following global variables in **`main.go`** which we will use to con insecure = os.Getenv("INSECURE_MODE") ) ``` +  ### Step 3: Instrument your Go application -To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your `main.go` file. +To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your **`main.go`** file. ```bash @@ -85,9 +90,10 @@ To configure your application to send data we will need a function to initialize return exporter.Shutdown } ``` +  -### Step 4: Initialise the tracer in `main.go` -Modify the main function to initialise the tracer in main.go. Initiate the tracer at the very beginning of our main function. +### Step 4: Initialise the tracer in **`main.go`** +Modify the main function to initialise the tracer in **`main.go`**. Initiate the tracer at the very beginning of our main function. ```bash func main() { cleanup := initTracer() @@ -96,9 +102,10 @@ func main() { ...... } ``` +  ### Step 5: Add the OpenTelemetry Gin middleware -Configure Gin to use the middleware by adding the following lines in `main.go` +Configure Gin to use the middleware by adding the following lines in **`main.go`** ```bash import ( .... diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/Recommended/golang-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/Recommended/golang-linuxamd64-recommended-runApplication.md index 8cf13365aa..6636d6b64f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/Recommended/golang-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxAMD64/Recommended/golang-linuxamd64-recommended-runApplication.md @@ -1,4 +1,6 @@ +  Once you are done intrumenting your Go Gin 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 @@ -6,15 +8,19 @@ Once you are done intrumenting your Go Gin application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  + ### Step 2: Set environment variables and run your Go Gin application ```bash SERVICE_NAME={{MYAPP}} INSECURE_MODE=true OTEL_EXPORTER_OTLP_ENDPOINT=localhost:4317 go run main.go diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/QuickStart/golang-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/QuickStart/golang-linuxarm64-quickStart-instrumentApplication.md index 7be1874b6d..642da55e8b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/QuickStart/golang-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/QuickStart/golang-linuxarm64-quickStart-instrumentApplication.md @@ -1,6 +1,9 @@ +After setting up the Otel collector agent, follow the steps below to instrument your Go Application +  +  ### Step 1: Install OpenTelemetry Dependencies -Dependencies related to OpenTelemetry exporter and SDK have to be installed first +Dependencies related to OpenTelemetry exporter and SDK have to be installed first. Run the below commands after navigating to the application source folder: ```bash @@ -12,7 +15,9 @@ go get go.opentelemetry.io/otel \ go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc ``` -**Note:** Note that we are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +**Note:** We are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +  +  ### Step 2: Declare environment variables for configuring OpenTelemetry Declare the following global variables in **`main.go`** which we will use to configure OpenTelemetry: @@ -23,9 +28,10 @@ Declare the following global variables in **`main.go`** which we will use to con insecure = os.Getenv("INSECURE_MODE") ) ``` +  ### Step 3: Instrument your Go application -To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your `main.go` file. +To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your **`main.go`** file. ```bash @@ -84,9 +90,10 @@ To configure your application to send data we will need a function to initialize return exporter.Shutdown } ``` +  -### Step 4: Initialise the tracer in `main.go` -Modify the main function to initialise the tracer in main.go. Initiate the tracer at the very beginning of our main function. +### Step 4: Initialise the tracer in **`main.go`** +Modify the main function to initialise the tracer in **`main.go`**. Initiate the tracer at the very beginning of our main function. ```bash func main() { cleanup := initTracer() @@ -95,9 +102,10 @@ func main() { ...... } ``` +  ### Step 5: Add the OpenTelemetry Gin middleware -Configure Gin to use the middleware by adding the following lines in `main.go` +Configure Gin to use the middleware by adding the following lines in **`main.go`** ```bash import ( .... diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/QuickStart/golang-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/QuickStart/golang-linuxarm64-quickStart-runApplication.md index 3d72dffe2e..c8952212f8 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/QuickStart/golang-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/QuickStart/golang-linuxarm64-quickStart-runApplication.md @@ -1,3 +1,4 @@ +  To run your Go Gin application, use the below command : ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/Recommended/golang-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/Recommended/golang-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..36553fba5a 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/Recommended/golang-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/Recommended/golang-linuxarm64-recommended-installOtelCollector.md @@ -1,16 +1,22 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  +  -### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it +### Step 3: Create `config.yaml` in `otelcol-contrib` folder with the below content in it ```bash receivers: otlp: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/Recommended/golang-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/Recommended/golang-linuxarm64-recommended-instrumentApplication.md index edf5710cf2..642da55e8b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/Recommended/golang-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/Recommended/golang-linuxarm64-recommended-instrumentApplication.md @@ -1,7 +1,9 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Go Application +After setting up the Otel collector agent, follow the steps below to instrument your Go Application +  +  ### Step 1: Install OpenTelemetry Dependencies -Dependencies related to OpenTelemetry exporter and SDK have to be installed first +Dependencies related to OpenTelemetry exporter and SDK have to be installed first. Run the below commands after navigating to the application source folder: ```bash @@ -13,7 +15,9 @@ go get go.opentelemetry.io/otel \ go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc ``` -**Note:** Note that we are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +**Note:** We are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +  +  ### Step 2: Declare environment variables for configuring OpenTelemetry Declare the following global variables in **`main.go`** which we will use to configure OpenTelemetry: @@ -24,9 +28,10 @@ Declare the following global variables in **`main.go`** which we will use to con insecure = os.Getenv("INSECURE_MODE") ) ``` +  ### Step 3: Instrument your Go application -To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your `main.go` file. +To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your **`main.go`** file. ```bash @@ -85,9 +90,10 @@ To configure your application to send data we will need a function to initialize return exporter.Shutdown } ``` +  -### Step 4: Initialise the tracer in `main.go` -Modify the main function to initialise the tracer in main.go. Initiate the tracer at the very beginning of our main function. +### Step 4: Initialise the tracer in **`main.go`** +Modify the main function to initialise the tracer in **`main.go`**. Initiate the tracer at the very beginning of our main function. ```bash func main() { cleanup := initTracer() @@ -96,9 +102,10 @@ func main() { ...... } ``` +  ### Step 5: Add the OpenTelemetry Gin middleware -Configure Gin to use the middleware by adding the following lines in `main.go` +Configure Gin to use the middleware by adding the following lines in **`main.go`** ```bash import ( .... diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/Recommended/golang-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/Recommended/golang-linuxarm64-recommended-runApplication.md index 8cf13365aa..6636d6b64f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/Recommended/golang-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/LinuxARM64/Recommended/golang-linuxarm64-recommended-runApplication.md @@ -1,4 +1,6 @@ +  Once you are done intrumenting your Go Gin 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 @@ -6,15 +8,19 @@ Once you are done intrumenting your Go Gin application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  + ### Step 2: Set environment variables and run your Go Gin application ```bash SERVICE_NAME={{MYAPP}} INSECURE_MODE=true OTEL_EXPORTER_OTLP_ENDPOINT=localhost:4317 go run main.go diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/QuickStart/golang-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/QuickStart/golang-macosamd64-quickStart-instrumentApplication.md index 7be1874b6d..642da55e8b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/QuickStart/golang-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/QuickStart/golang-macosamd64-quickStart-instrumentApplication.md @@ -1,6 +1,9 @@ +After setting up the Otel collector agent, follow the steps below to instrument your Go Application +  +  ### Step 1: Install OpenTelemetry Dependencies -Dependencies related to OpenTelemetry exporter and SDK have to be installed first +Dependencies related to OpenTelemetry exporter and SDK have to be installed first. Run the below commands after navigating to the application source folder: ```bash @@ -12,7 +15,9 @@ go get go.opentelemetry.io/otel \ go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc ``` -**Note:** Note that we are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +**Note:** We are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +  +  ### Step 2: Declare environment variables for configuring OpenTelemetry Declare the following global variables in **`main.go`** which we will use to configure OpenTelemetry: @@ -23,9 +28,10 @@ Declare the following global variables in **`main.go`** which we will use to con insecure = os.Getenv("INSECURE_MODE") ) ``` +  ### Step 3: Instrument your Go application -To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your `main.go` file. +To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your **`main.go`** file. ```bash @@ -84,9 +90,10 @@ To configure your application to send data we will need a function to initialize return exporter.Shutdown } ``` +  -### Step 4: Initialise the tracer in `main.go` -Modify the main function to initialise the tracer in main.go. Initiate the tracer at the very beginning of our main function. +### Step 4: Initialise the tracer in **`main.go`** +Modify the main function to initialise the tracer in **`main.go`**. Initiate the tracer at the very beginning of our main function. ```bash func main() { cleanup := initTracer() @@ -95,9 +102,10 @@ func main() { ...... } ``` +  ### Step 5: Add the OpenTelemetry Gin middleware -Configure Gin to use the middleware by adding the following lines in `main.go` +Configure Gin to use the middleware by adding the following lines in **`main.go`** ```bash import ( .... diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/QuickStart/golang-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/QuickStart/golang-macosamd64-quickStart-runApplication.md index 3d72dffe2e..c8952212f8 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/QuickStart/golang-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/QuickStart/golang-macosamd64-quickStart-runApplication.md @@ -1,3 +1,4 @@ +  To run your Go Gin application, use the below command : ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/Recommended/golang-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/Recommended/golang-macosamd64-recommended-installOtelCollector.md index ffd03775a4..2bd05c79fa 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/Recommended/golang-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/Recommended/golang-macosamd64-recommended-installOtelCollector.md @@ -1,16 +1,19 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  -### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it +### Step 3: Create `config.yaml` in folder `otelcol-contrib` with the below content in it ```bash receivers: otlp: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/Recommended/golang-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/Recommended/golang-macosamd64-recommended-instrumentApplication.md index edf5710cf2..642da55e8b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/Recommended/golang-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/Recommended/golang-macosamd64-recommended-instrumentApplication.md @@ -1,7 +1,9 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Go Application +After setting up the Otel collector agent, follow the steps below to instrument your Go Application +  +  ### Step 1: Install OpenTelemetry Dependencies -Dependencies related to OpenTelemetry exporter and SDK have to be installed first +Dependencies related to OpenTelemetry exporter and SDK have to be installed first. Run the below commands after navigating to the application source folder: ```bash @@ -13,7 +15,9 @@ go get go.opentelemetry.io/otel \ go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc ``` -**Note:** Note that we are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +**Note:** We are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +  +  ### Step 2: Declare environment variables for configuring OpenTelemetry Declare the following global variables in **`main.go`** which we will use to configure OpenTelemetry: @@ -24,9 +28,10 @@ Declare the following global variables in **`main.go`** which we will use to con insecure = os.Getenv("INSECURE_MODE") ) ``` +  ### Step 3: Instrument your Go application -To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your `main.go` file. +To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your **`main.go`** file. ```bash @@ -85,9 +90,10 @@ To configure your application to send data we will need a function to initialize return exporter.Shutdown } ``` +  -### Step 4: Initialise the tracer in `main.go` -Modify the main function to initialise the tracer in main.go. Initiate the tracer at the very beginning of our main function. +### Step 4: Initialise the tracer in **`main.go`** +Modify the main function to initialise the tracer in **`main.go`**. Initiate the tracer at the very beginning of our main function. ```bash func main() { cleanup := initTracer() @@ -96,9 +102,10 @@ func main() { ...... } ``` +  ### Step 5: Add the OpenTelemetry Gin middleware -Configure Gin to use the middleware by adding the following lines in `main.go` +Configure Gin to use the middleware by adding the following lines in **`main.go`** ```bash import ( .... diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/Recommended/golang-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/Recommended/golang-macosamd64-recommended-runApplication.md index 8cf13365aa..6636d6b64f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/Recommended/golang-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsAMD64/Recommended/golang-macosamd64-recommended-runApplication.md @@ -1,4 +1,6 @@ +  Once you are done intrumenting your Go Gin 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 @@ -6,15 +8,19 @@ Once you are done intrumenting your Go Gin application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  + ### Step 2: Set environment variables and run your Go Gin application ```bash SERVICE_NAME={{MYAPP}} INSECURE_MODE=true OTEL_EXPORTER_OTLP_ENDPOINT=localhost:4317 go run main.go diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/QuickStart/golang-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/QuickStart/golang-macosarm64-quickStart-instrumentApplication.md index 7be1874b6d..642da55e8b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/QuickStart/golang-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/QuickStart/golang-macosarm64-quickStart-instrumentApplication.md @@ -1,6 +1,9 @@ +After setting up the Otel collector agent, follow the steps below to instrument your Go Application +  +  ### Step 1: Install OpenTelemetry Dependencies -Dependencies related to OpenTelemetry exporter and SDK have to be installed first +Dependencies related to OpenTelemetry exporter and SDK have to be installed first. Run the below commands after navigating to the application source folder: ```bash @@ -12,7 +15,9 @@ go get go.opentelemetry.io/otel \ go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc ``` -**Note:** Note that we are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +**Note:** We are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +  +  ### Step 2: Declare environment variables for configuring OpenTelemetry Declare the following global variables in **`main.go`** which we will use to configure OpenTelemetry: @@ -23,9 +28,10 @@ Declare the following global variables in **`main.go`** which we will use to con insecure = os.Getenv("INSECURE_MODE") ) ``` +  ### Step 3: Instrument your Go application -To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your `main.go` file. +To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your **`main.go`** file. ```bash @@ -84,9 +90,10 @@ To configure your application to send data we will need a function to initialize return exporter.Shutdown } ``` +  -### Step 4: Initialise the tracer in `main.go` -Modify the main function to initialise the tracer in main.go. Initiate the tracer at the very beginning of our main function. +### Step 4: Initialise the tracer in **`main.go`** +Modify the main function to initialise the tracer in **`main.go`**. Initiate the tracer at the very beginning of our main function. ```bash func main() { cleanup := initTracer() @@ -95,9 +102,10 @@ func main() { ...... } ``` +  ### Step 5: Add the OpenTelemetry Gin middleware -Configure Gin to use the middleware by adding the following lines in `main.go` +Configure Gin to use the middleware by adding the following lines in **`main.go`** ```bash import ( .... diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/QuickStart/golang-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/QuickStart/golang-macosarm64-quickStart-runApplication.md index 3d72dffe2e..c8952212f8 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/QuickStart/golang-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/QuickStart/golang-macosarm64-quickStart-runApplication.md @@ -1,3 +1,4 @@ +  To run your Go Gin application, use the below command : ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/Recommended/golang-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/Recommended/golang-macosarm64-recommended-installOtelCollector.md index ab4a153670..c326cedbee 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/Recommended/golang-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/Recommended/golang-macosarm64-recommended-installOtelCollector.md @@ -1,15 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  -### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it +### Step 3: Create `config.yaml` in folder `otelcol-contrib` with the below content in it ```bash receivers: otlp: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/Recommended/golang-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/Recommended/golang-macosarm64-recommended-instrumentApplication.md index edf5710cf2..642da55e8b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/Recommended/golang-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/Recommended/golang-macosarm64-recommended-instrumentApplication.md @@ -1,7 +1,9 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Go Application +After setting up the Otel collector agent, follow the steps below to instrument your Go Application +  +  ### Step 1: Install OpenTelemetry Dependencies -Dependencies related to OpenTelemetry exporter and SDK have to be installed first +Dependencies related to OpenTelemetry exporter and SDK have to be installed first. Run the below commands after navigating to the application source folder: ```bash @@ -13,7 +15,9 @@ go get go.opentelemetry.io/otel \ go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc ``` -**Note:** Note that we are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +**Note:** We are assuming you are using gin request router. If you are using other request routers, check out the [corresponding package](https://signoz.io/docs/instrumentation/golang/#request-routers). +  +  ### Step 2: Declare environment variables for configuring OpenTelemetry Declare the following global variables in **`main.go`** which we will use to configure OpenTelemetry: @@ -24,9 +28,10 @@ Declare the following global variables in **`main.go`** which we will use to con insecure = os.Getenv("INSECURE_MODE") ) ``` +  ### Step 3: Instrument your Go application -To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your `main.go` file. +To configure your application to send data we will need a function to initialize OpenTelemetry. Add the following snippet of code in your **`main.go`** file. ```bash @@ -85,9 +90,10 @@ To configure your application to send data we will need a function to initialize return exporter.Shutdown } ``` +  -### Step 4: Initialise the tracer in `main.go` -Modify the main function to initialise the tracer in main.go. Initiate the tracer at the very beginning of our main function. +### Step 4: Initialise the tracer in **`main.go`** +Modify the main function to initialise the tracer in **`main.go`**. Initiate the tracer at the very beginning of our main function. ```bash func main() { cleanup := initTracer() @@ -96,9 +102,10 @@ func main() { ...... } ``` +  ### Step 5: Add the OpenTelemetry Gin middleware -Configure Gin to use the middleware by adding the following lines in `main.go` +Configure Gin to use the middleware by adding the following lines in **`main.go`** ```bash import ( .... diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/Recommended/golang-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/Recommended/golang-macosarm64-recommended-runApplication.md index 8cf13365aa..6636d6b64f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/Recommended/golang-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/GoLang/md-docs/MacOsARM64/Recommended/golang-macosarm64-recommended-runApplication.md @@ -1,4 +1,6 @@ +  Once you are done intrumenting your Go Gin 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 @@ -6,15 +8,19 @@ Once you are done intrumenting your Go Gin application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  + ### Step 2: Set environment variables and run your Go Gin application ```bash SERVICE_NAME={{MYAPP}} INSECURE_MODE=true OTEL_EXPORTER_OTLP_ENDPOINT=localhost:4317 go run main.go diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/Kubernetes/jboss-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/Kubernetes/jboss-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/Kubernetes/jboss-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/Kubernetes/jboss-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/Kubernetes/jboss-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/Kubernetes/jboss-kubernetes-instrumentApplication.md index 5a6c5fb7d8..bf51b2d8ea 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/Kubernetes/jboss-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/Kubernetes/jboss-kubernetes-instrumentApplication.md @@ -1,8 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Java 8 or higher +  + ### Download otel java binary ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/Kubernetes/jboss-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/Kubernetes/jboss-kubernetes-runApplication.md index 7a5feac352..12eaef4145 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/Kubernetes/jboss-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/Kubernetes/jboss-kubernetes-runApplication.md @@ -2,6 +2,7 @@ ```bash vim /opt/jboss-eap-7.1/bin/standalone.conf ``` +  ### Update `JAVA_OPTS` environment variable ```bash @@ -9,6 +10,11 @@ JAVA_OPTS="-javaagent://opentelemetry-javaagent.jar" ``` - update it to the path where you downloaded the Java JAR agent in previous step +  **Note:** - In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/jboss/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/QuickStart/jboss-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/QuickStart/jboss-linuxamd64-quickStart-instrumentApplication.md index b7804e1ec8..a5bceef884 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/QuickStart/jboss-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/QuickStart/jboss-linuxamd64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Java 8 or higher +  + ### Download otel java binary ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/QuickStart/jboss-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/QuickStart/jboss-linuxamd64-quickStart-runApplication.md index 108d2b6f8a..c3f251c884 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/QuickStart/jboss-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/QuickStart/jboss-linuxamd64-quickStart-runApplication.md @@ -2,6 +2,7 @@ ```bash vim /opt/jboss-eap-7.1/bin/standalone.conf ``` +  ### Update `JAVA_OPTS` environment variable Update `JAVA_OPTS` environment variable with configurations required to send data to SigNoz cloud in your configuration file. @@ -15,9 +16,13 @@ JAVA_OPTS="-javaagent://opentelemetry-javaagent.jar - update it to the path where you downloaded the Java JAR agent in previous step +  -### (Optional step) Write the output/logs of standalone.sh script to a file nohup.out as a background thread +#### (Optional step) Write the output/logs of standalone.sh script to a file nohup.out as a background thread ```bash /opt/jboss-eap-7.1/bin/standalone.sh > /opt/jboss-eap-7.1/bin/nohup.out & ``` +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/jboss/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/Recommended/jboss-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/Recommended/jboss-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/Recommended/jboss-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/Recommended/jboss-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/Recommended/jboss-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/Recommended/jboss-linuxamd64-recommended-instrumentApplication.md index 5a6c5fb7d8..a3ed4f578f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/Recommended/jboss-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/Recommended/jboss-linuxamd64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/Recommended/jboss-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/Recommended/jboss-linuxamd64-recommended-runApplication.md index 4a8cb9b223..26fbf94235 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/Recommended/jboss-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxAMD64/Recommended/jboss-linuxamd64-recommended-runApplication.md @@ -1,4 +1,5 @@ Once you are done intrumenting your Java 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 @@ -6,20 +7,24 @@ Once you are done intrumenting your Java application, you can run it using the b ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Open `standalone.conf` Configuration File ```bash vim /opt/jboss-eap-7.1/bin/standalone.conf ``` +  ### Step 3: Update `JAVA_OPTS` environment variable ```bash @@ -28,3 +33,6 @@ JAVA_OPTS="-javaagent://opentelemetry-javaagent.jar" - update it to the path where you downloaded the Java JAR agent in previous step +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/jboss/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/QuickStart/jboss-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/QuickStart/jboss-linuxarm64-quickStart-instrumentApplication.md index b7804e1ec8..a5bceef884 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/QuickStart/jboss-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/QuickStart/jboss-linuxarm64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Java 8 or higher +  + ### Download otel java binary ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/QuickStart/jboss-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/QuickStart/jboss-linuxarm64-quickStart-runApplication.md index 108d2b6f8a..c3f251c884 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/QuickStart/jboss-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/QuickStart/jboss-linuxarm64-quickStart-runApplication.md @@ -2,6 +2,7 @@ ```bash vim /opt/jboss-eap-7.1/bin/standalone.conf ``` +  ### Update `JAVA_OPTS` environment variable Update `JAVA_OPTS` environment variable with configurations required to send data to SigNoz cloud in your configuration file. @@ -15,9 +16,13 @@ JAVA_OPTS="-javaagent://opentelemetry-javaagent.jar - update it to the path where you downloaded the Java JAR agent in previous step +  -### (Optional step) Write the output/logs of standalone.sh script to a file nohup.out as a background thread +#### (Optional step) Write the output/logs of standalone.sh script to a file nohup.out as a background thread ```bash /opt/jboss-eap-7.1/bin/standalone.sh > /opt/jboss-eap-7.1/bin/nohup.out & ``` +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/jboss/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/Recommended/jboss-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/Recommended/jboss-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/Recommended/jboss-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/Recommended/jboss-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/Recommended/jboss-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/Recommended/jboss-linuxarm64-recommended-instrumentApplication.md index 5a6c5fb7d8..a3ed4f578f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/Recommended/jboss-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/Recommended/jboss-linuxarm64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/Recommended/jboss-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/Recommended/jboss-linuxarm64-recommended-runApplication.md index 4a8cb9b223..26fbf94235 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/Recommended/jboss-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/LinuxARM64/Recommended/jboss-linuxarm64-recommended-runApplication.md @@ -1,4 +1,5 @@ Once you are done intrumenting your Java 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 @@ -6,20 +7,24 @@ Once you are done intrumenting your Java application, you can run it using the b ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Open `standalone.conf` Configuration File ```bash vim /opt/jboss-eap-7.1/bin/standalone.conf ``` +  ### Step 3: Update `JAVA_OPTS` environment variable ```bash @@ -28,3 +33,6 @@ JAVA_OPTS="-javaagent://opentelemetry-javaagent.jar" - update it to the path where you downloaded the Java JAR agent in previous step +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/jboss/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/QuickStart/jboss-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/QuickStart/jboss-macosamd64-quickStart-instrumentApplication.md index b7804e1ec8..a5bceef884 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/QuickStart/jboss-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/QuickStart/jboss-macosamd64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Java 8 or higher +  + ### Download otel java binary ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/QuickStart/jboss-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/QuickStart/jboss-macosamd64-quickStart-runApplication.md index 108d2b6f8a..c3f251c884 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/QuickStart/jboss-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/QuickStart/jboss-macosamd64-quickStart-runApplication.md @@ -2,6 +2,7 @@ ```bash vim /opt/jboss-eap-7.1/bin/standalone.conf ``` +  ### Update `JAVA_OPTS` environment variable Update `JAVA_OPTS` environment variable with configurations required to send data to SigNoz cloud in your configuration file. @@ -15,9 +16,13 @@ JAVA_OPTS="-javaagent://opentelemetry-javaagent.jar - update it to the path where you downloaded the Java JAR agent in previous step +  -### (Optional step) Write the output/logs of standalone.sh script to a file nohup.out as a background thread +#### (Optional step) Write the output/logs of standalone.sh script to a file nohup.out as a background thread ```bash /opt/jboss-eap-7.1/bin/standalone.sh > /opt/jboss-eap-7.1/bin/nohup.out & ``` +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/jboss/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/Recommended/jboss-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/Recommended/jboss-macosamd64-recommended-installOtelCollector.md index ffd03775a4..843e86a411 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/Recommended/jboss-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/Recommended/jboss-macosamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ ### 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/Recommended/jboss-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/Recommended/jboss-macosamd64-recommended-instrumentApplication.md index 5a6c5fb7d8..a3ed4f578f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/Recommended/jboss-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/Recommended/jboss-macosamd64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/Recommended/jboss-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/Recommended/jboss-macosamd64-recommended-runApplication.md index 4a8cb9b223..26fbf94235 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/Recommended/jboss-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsAMD64/Recommended/jboss-macosamd64-recommended-runApplication.md @@ -1,4 +1,5 @@ Once you are done intrumenting your Java 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 @@ -6,20 +7,24 @@ Once you are done intrumenting your Java application, you can run it using the b ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Open `standalone.conf` Configuration File ```bash vim /opt/jboss-eap-7.1/bin/standalone.conf ``` +  ### Step 3: Update `JAVA_OPTS` environment variable ```bash @@ -28,3 +33,6 @@ JAVA_OPTS="-javaagent://opentelemetry-javaagent.jar" - update it to the path where you downloaded the Java JAR agent in previous step +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/jboss/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/QuickStart/jboss-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/QuickStart/jboss-macosarm64-quickStart-instrumentApplication.md index b7804e1ec8..a5bceef884 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/QuickStart/jboss-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/QuickStart/jboss-macosarm64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Java 8 or higher +  + ### Download otel java binary ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/QuickStart/jboss-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/QuickStart/jboss-macosarm64-quickStart-runApplication.md index 108d2b6f8a..c3f251c884 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/QuickStart/jboss-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/QuickStart/jboss-macosarm64-quickStart-runApplication.md @@ -2,6 +2,7 @@ ```bash vim /opt/jboss-eap-7.1/bin/standalone.conf ``` +  ### Update `JAVA_OPTS` environment variable Update `JAVA_OPTS` environment variable with configurations required to send data to SigNoz cloud in your configuration file. @@ -15,9 +16,13 @@ JAVA_OPTS="-javaagent://opentelemetry-javaagent.jar - update it to the path where you downloaded the Java JAR agent in previous step +  -### (Optional step) Write the output/logs of standalone.sh script to a file nohup.out as a background thread +#### (Optional step) Write the output/logs of standalone.sh script to a file nohup.out as a background thread ```bash /opt/jboss-eap-7.1/bin/standalone.sh > /opt/jboss-eap-7.1/bin/nohup.out & ``` +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/jboss/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/Recommended/jboss-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/Recommended/jboss-macosarm64-recommended-installOtelCollector.md index ab4a153670..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/Recommended/jboss-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/Recommended/jboss-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/Recommended/jboss-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/Recommended/jboss-macosarm64-recommended-instrumentApplication.md index 5a6c5fb7d8..a3ed4f578f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/Recommended/jboss-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/Recommended/jboss-macosarm64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/Recommended/jboss-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/Recommended/jboss-macosarm64-recommended-runApplication.md index 4a8cb9b223..26fbf94235 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/Recommended/jboss-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Jboss/MacOsARM64/Recommended/jboss-macosarm64-recommended-runApplication.md @@ -1,4 +1,5 @@ Once you are done intrumenting your Java 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 @@ -6,20 +7,24 @@ Once you are done intrumenting your Java application, you can run it using the b ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Open `standalone.conf` Configuration File ```bash vim /opt/jboss-eap-7.1/bin/standalone.conf ``` +  ### Step 3: Update `JAVA_OPTS` environment variable ```bash @@ -28,3 +33,6 @@ JAVA_OPTS="-javaagent://opentelemetry-javaagent.jar" - update it to the path where you downloaded the Java JAR agent in previous step +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/jboss/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/Kubernetes/others-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/Kubernetes/others-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/Kubernetes/others-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/Kubernetes/others-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/Kubernetes/others-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/Kubernetes/others-kubernetes-instrumentApplication.md index 5a6c5fb7d8..5c59ca0e82 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/Kubernetes/others-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/Kubernetes/others-kubernetes-instrumentApplication.md @@ -1,8 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  + ### Download otel java binary ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/Kubernetes/others-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/Kubernetes/others-kubernetes-runApplication.md index 66ffc13c2f..da9b7e905f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/Kubernetes/others-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/Kubernetes/others-kubernetes-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your Java application, you can run it using the below command ```bash @@ -5,6 +7,11 @@ java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar ``` - update it to the path where you downloaded the Java JAR agent in previous step +  **Note:** - In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/java/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-instrumentApplication.md index 66c8e8fe37..f60ece8955 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-instrumentApplication.md @@ -1,5 +1,6 @@ #### Requirements - Java 8 or higher +  ### Download otel java binary agent diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-runApplication.md index d0be056eaa..b89669f193 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-runApplication.md @@ -10,5 +10,7 @@ java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar - update it to the path where you downloaded the Java JAR agent in previous step +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/java/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-instrumentApplication.md index 5a6c5fb7d8..0a125cf192 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-runApplication.md index cf26e726fc..da3bcc817f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-runApplication.md @@ -1,4 +1,7 @@ -OOnce you are done intrumenting your Java application, you can run it using the below commands +  + +Once you are done intrumenting your Java 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 @@ -6,15 +9,19 @@ OOnce you are done intrumenting your Java application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  + ### Step 2: Run your application ```bash java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-instrumentApplication.md index 66c8e8fe37..f60ece8955 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-instrumentApplication.md @@ -1,5 +1,6 @@ #### Requirements - Java 8 or higher +  ### Download otel java binary agent diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-runApplication.md index d0be056eaa..b89669f193 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-runApplication.md @@ -10,5 +10,7 @@ java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar - update it to the path where you downloaded the Java JAR agent in previous step +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/java/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-instrumentApplication.md index 5a6c5fb7d8..0a125cf192 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-runApplication.md index cf26e726fc..da3bcc817f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-runApplication.md @@ -1,4 +1,7 @@ -OOnce you are done intrumenting your Java application, you can run it using the below commands +  + +Once you are done intrumenting your Java 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 @@ -6,15 +9,19 @@ OOnce you are done intrumenting your Java application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  + ### Step 2: Run your application ```bash java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-instrumentApplication.md index 66c8e8fe37..f60ece8955 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-instrumentApplication.md @@ -1,5 +1,6 @@ #### Requirements - Java 8 or higher +  ### Download otel java binary agent diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-runApplication.md index d0be056eaa..b89669f193 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-runApplication.md @@ -10,5 +10,7 @@ java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar - update it to the path where you downloaded the Java JAR agent in previous step +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/java/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-installOtelCollector.md index ffd03775a4..843e86a411 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ ### 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-instrumentApplication.md index 5a6c5fb7d8..0a125cf192 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-runApplication.md index cf26e726fc..da3bcc817f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-runApplication.md @@ -1,4 +1,7 @@ -OOnce you are done intrumenting your Java application, you can run it using the below commands +  + +Once you are done intrumenting your Java 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 @@ -6,15 +9,19 @@ OOnce you are done intrumenting your Java application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  + ### Step 2: Run your application ```bash java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-instrumentApplication.md index 66c8e8fe37..f60ece8955 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-instrumentApplication.md @@ -1,5 +1,6 @@ #### Requirements - Java 8 or higher +  ### Download otel java binary agent diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-runApplication.md index d0be056eaa..b89669f193 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-runApplication.md @@ -10,5 +10,7 @@ java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar - update it to the path where you downloaded the Java JAR agent in previous step +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/java/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-installOtelCollector.md index ab4a153670..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-instrumentApplication.md index 5a6c5fb7d8..0a125cf192 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-runApplication.md index cf26e726fc..ec824bb196 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-runApplication.md @@ -1,4 +1,7 @@ -OOnce you are done intrumenting your Java application, you can run it using the below commands +  + +Once you are done intrumenting your Java 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 @@ -6,12 +9,14 @@ OOnce you are done intrumenting your Java application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/Kubernetes/springBoot-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/Kubernetes/springBoot-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/Kubernetes/springBoot-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/Kubernetes/springBoot-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/Kubernetes/springBoot-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/Kubernetes/springBoot-kubernetes-instrumentApplication.md index 5a6c5fb7d8..797dd5f753 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/Kubernetes/springBoot-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/Kubernetes/springBoot-kubernetes-instrumentApplication.md @@ -1,7 +1,9 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +  +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/Kubernetes/springBoot-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/Kubernetes/springBoot-kubernetes-runApplication.md index fa2f63d183..bd09dabcb6 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/Kubernetes/springBoot-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/Kubernetes/springBoot-kubernetes-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your Java application, you can run it using the below commands @@ -7,5 +9,11 @@ java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar - update it to the path where you downloaded the Java JAR agent in previous step +  + **Note:** - In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/springboot/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/QuickStart/springBoot-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/QuickStart/springBoot-linuxamd64-quickStart-instrumentApplication.md index 97189d1f3c..16b0c44a14 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/QuickStart/springBoot-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/QuickStart/springBoot-linuxamd64-quickStart-instrumentApplication.md @@ -2,6 +2,8 @@ #### Requirements - Java 8 or higher +  + ### Download otel java binary agent ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/QuickStart/springBoot-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/QuickStart/springBoot-linuxamd64-quickStart-runApplication.md index d0be056eaa..6cf655bbd9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/QuickStart/springBoot-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/QuickStart/springBoot-linuxamd64-quickStart-runApplication.md @@ -10,5 +10,7 @@ java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar - update it to the path where you downloaded the Java JAR agent in previous step +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/springboot/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/Recommended/springBoot-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/Recommended/springBoot-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/Recommended/springBoot-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/Recommended/springBoot-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/Recommended/springBoot-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/Recommended/springBoot-linuxamd64-recommended-instrumentApplication.md index 5a6c5fb7d8..0a125cf192 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/Recommended/springBoot-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/Recommended/springBoot-linuxamd64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/Recommended/springBoot-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/Recommended/springBoot-linuxamd64-recommended-runApplication.md index d325db20e3..cd60c65bae 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/Recommended/springBoot-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxAMD64/Recommended/springBoot-linuxamd64-recommended-runApplication.md @@ -1,4 +1,7 @@ +  + Once you are done intrumenting your Java 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 @@ -6,21 +9,28 @@ Once you are done intrumenting your Java application, you can run it using the b ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar ``` +  - update it to the path where you downloaded the Java JAR agent in previous step +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/springboot/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/QuickStart/springBoot-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/QuickStart/springBoot-linuxarm64-quickStart-instrumentApplication.md index 97189d1f3c..16b0c44a14 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/QuickStart/springBoot-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/QuickStart/springBoot-linuxarm64-quickStart-instrumentApplication.md @@ -2,6 +2,8 @@ #### Requirements - Java 8 or higher +  + ### Download otel java binary agent ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/QuickStart/springBoot-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/QuickStart/springBoot-linuxarm64-quickStart-runApplication.md index d0be056eaa..6cf655bbd9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/QuickStart/springBoot-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/QuickStart/springBoot-linuxarm64-quickStart-runApplication.md @@ -10,5 +10,7 @@ java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar - update it to the path where you downloaded the Java JAR agent in previous step +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/springboot/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/Recommended/springBoot-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/Recommended/springBoot-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/Recommended/springBoot-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/Recommended/springBoot-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/Recommended/springBoot-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/Recommended/springBoot-linuxarm64-recommended-instrumentApplication.md index 5a6c5fb7d8..0a125cf192 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/Recommended/springBoot-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/Recommended/springBoot-linuxarm64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/Recommended/springBoot-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/Recommended/springBoot-linuxarm64-recommended-runApplication.md index d325db20e3..cd60c65bae 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/Recommended/springBoot-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/LinuxARM64/Recommended/springBoot-linuxarm64-recommended-runApplication.md @@ -1,4 +1,7 @@ +  + Once you are done intrumenting your Java 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 @@ -6,21 +9,28 @@ Once you are done intrumenting your Java application, you can run it using the b ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar ``` +  - update it to the path where you downloaded the Java JAR agent in previous step +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/springboot/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/QuickStart/springBoot-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/QuickStart/springBoot-macosamd64-quickStart-instrumentApplication.md index 97189d1f3c..16b0c44a14 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/QuickStart/springBoot-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/QuickStart/springBoot-macosamd64-quickStart-instrumentApplication.md @@ -2,6 +2,8 @@ #### Requirements - Java 8 or higher +  + ### Download otel java binary agent ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/QuickStart/springBoot-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/QuickStart/springBoot-macosamd64-quickStart-runApplication.md index d0be056eaa..6cf655bbd9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/QuickStart/springBoot-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/QuickStart/springBoot-macosamd64-quickStart-runApplication.md @@ -10,5 +10,7 @@ java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar - update it to the path where you downloaded the Java JAR agent in previous step +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/springboot/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/Recommended/springBoot-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/Recommended/springBoot-macosamd64-recommended-installOtelCollector.md index ffd03775a4..843e86a411 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/Recommended/springBoot-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/Recommended/springBoot-macosamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ ### 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/Recommended/springBoot-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/Recommended/springBoot-macosamd64-recommended-instrumentApplication.md index 5a6c5fb7d8..0a125cf192 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/Recommended/springBoot-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/Recommended/springBoot-macosamd64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/Recommended/springBoot-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/Recommended/springBoot-macosamd64-recommended-runApplication.md index 8bd1680e74..cd60c65bae 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/Recommended/springBoot-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsAMD64/Recommended/springBoot-macosamd64-recommended-runApplication.md @@ -1,4 +1,7 @@ +  + Once you are done intrumenting your Java 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 @@ -6,20 +9,28 @@ Once you are done intrumenting your Java application, you can run it using the b ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar ``` +  - update it to the path where you downloaded the Java JAR agent in previous step + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/springboot/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/QuickStart/springBoot-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/QuickStart/springBoot-macosarm64-quickStart-instrumentApplication.md index 97189d1f3c..16b0c44a14 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/QuickStart/springBoot-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/QuickStart/springBoot-macosarm64-quickStart-instrumentApplication.md @@ -2,6 +2,8 @@ #### Requirements - Java 8 or higher +  + ### Download otel java binary agent ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/QuickStart/springBoot-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/QuickStart/springBoot-macosarm64-quickStart-runApplication.md index d0be056eaa..6cf655bbd9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/QuickStart/springBoot-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/QuickStart/springBoot-macosarm64-quickStart-runApplication.md @@ -10,5 +10,7 @@ java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar - update it to the path where you downloaded the Java JAR agent in previous step +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/springboot/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/Recommended/springBoot-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/Recommended/springBoot-macosarm64-recommended-installOtelCollector.md index ab4a153670..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/Recommended/springBoot-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/Recommended/springBoot-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/Recommended/springBoot-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/Recommended/springBoot-macosarm64-recommended-instrumentApplication.md index 5a6c5fb7d8..0a125cf192 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/Recommended/springBoot-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/Recommended/springBoot-macosarm64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/Recommended/springBoot-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/Recommended/springBoot-macosarm64-recommended-runApplication.md index 8bd1680e74..cd60c65bae 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/Recommended/springBoot-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/SpringBoot/MacOsARM64/Recommended/springBoot-macosarm64-recommended-runApplication.md @@ -1,4 +1,7 @@ +  + Once you are done intrumenting your Java 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 @@ -6,20 +9,28 @@ Once you are done intrumenting your Java application, you can run it using the b ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash java -javaagent:/opentelemetry-javaagent.jar -jar {{MYAPP}}.jar ``` +  - update it to the path where you downloaded the Java JAR agent in previous step + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/springboot/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/Kubernetes/tomcat-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/Kubernetes/tomcat-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/Kubernetes/tomcat-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/Kubernetes/tomcat-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/Kubernetes/tomcat-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/Kubernetes/tomcat-kubernetes-instrumentApplication.md index 5a6c5fb7d8..a3ed4f578f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/Kubernetes/tomcat-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/Kubernetes/tomcat-kubernetes-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Java 8 or higher +  ### Download otel java binary diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/Kubernetes/tomcat-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/Kubernetes/tomcat-kubernetes-runApplication.md index 50d7e7ccee..7c4cf568b0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/Kubernetes/tomcat-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/Kubernetes/tomcat-kubernetes-runApplication.md @@ -1,14 +1,24 @@ -### Enable the instrumentation agent and run your application +## Enable the instrumentation agent and run your application +  If you run your .war package by putting in webapps folder, just add setenv.sh in your Tomcat bin folder. +  This should set the environment variable and start sending telemetry data to SigNoz Cloud. ```bash export CATALINA_OPTS="$CATALINA_OPTS -javaagent://opentelemetry-javaagent.jar" ``` +  - update it to the path where you downloaded the Java JAR agent in previous step +  +  + **Note:** -- In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. \ No newline at end of file +- In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/tomcat/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/QuickStart/tomcat-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/QuickStart/tomcat-linuxamd64-quickStart-instrumentApplication.md index fe3d25fd84..2fbd471fe1 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/QuickStart/tomcat-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/QuickStart/tomcat-linuxamd64-quickStart-instrumentApplication.md @@ -1,5 +1,6 @@ #### Requirements - Java 8 or higher +  ### Download otel java binary agent diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/QuickStart/tomcat-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/QuickStart/tomcat-linuxamd64-quickStart-runApplication.md index 1160901c1f..d826a9063c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/QuickStart/tomcat-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/QuickStart/tomcat-linuxamd64-quickStart-runApplication.md @@ -1,6 +1,8 @@ -### Enable the instrumentation agent and run your application +## Enable the instrumentation agent and run your application +  If you run your .war package by putting in webapps folder, just add setenv.sh in your Tomcat bin folder. +  This should set these environment variables and start sending telemetry data to SigNoz Cloud. @@ -10,5 +12,11 @@ export OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" export OTEL_EXPORTER_OTLP_ENDPOINT=https://ingest.{{REGION}}.signoz.cloud:443 export OTEL_RESOURCE_ATTRIBUTES=service.name={{MYAPP}} ``` +  - update it to the path where you downloaded the Java JAR agent in previous step + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/tomcat/#troubleshooting-your-installation) for assistance. + diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/Recommended/tomcat-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/Recommended/tomcat-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/Recommended/tomcat-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/Recommended/tomcat-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/Recommended/tomcat-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/Recommended/tomcat-linuxamd64-recommended-instrumentApplication.md index 5a6c5fb7d8..539f667fb0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/Recommended/tomcat-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/Recommended/tomcat-linuxamd64-recommended-instrumentApplication.md @@ -1,9 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  -### Download otel java binary +### Download otel java binary agent ```bash wget https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/Recommended/tomcat-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/Recommended/tomcat-linuxamd64-recommended-runApplication.md index 49b3656d66..81b2604ca4 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/Recommended/tomcat-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxAMD64/Recommended/tomcat-linuxamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your Java application, you can run it using the below commands ### Step 1: Run OTel Collector @@ -6,15 +8,18 @@ Once you are done intrumenting your Java application, you can run it using the b ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Enable the instrumentation agent and run your application @@ -25,5 +30,10 @@ This should set the environment variable and start sending telemetry data to Sig ```bash export CATALINA_OPTS="$CATALINA_OPTS -javaagent://opentelemetry-javaagent.jar" ``` +  - update it to the path where you downloaded the Java JAR agent in previous step + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/tomcat/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/QuickStart/tomcat-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/QuickStart/tomcat-linuxarm64-quickStart-instrumentApplication.md index fe3d25fd84..2fbd471fe1 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/QuickStart/tomcat-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/QuickStart/tomcat-linuxarm64-quickStart-instrumentApplication.md @@ -1,5 +1,6 @@ #### Requirements - Java 8 or higher +  ### Download otel java binary agent diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/QuickStart/tomcat-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/QuickStart/tomcat-linuxarm64-quickStart-runApplication.md index 1160901c1f..d826a9063c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/QuickStart/tomcat-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/QuickStart/tomcat-linuxarm64-quickStart-runApplication.md @@ -1,6 +1,8 @@ -### Enable the instrumentation agent and run your application +## Enable the instrumentation agent and run your application +  If you run your .war package by putting in webapps folder, just add setenv.sh in your Tomcat bin folder. +  This should set these environment variables and start sending telemetry data to SigNoz Cloud. @@ -10,5 +12,11 @@ export OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" export OTEL_EXPORTER_OTLP_ENDPOINT=https://ingest.{{REGION}}.signoz.cloud:443 export OTEL_RESOURCE_ATTRIBUTES=service.name={{MYAPP}} ``` +  - update it to the path where you downloaded the Java JAR agent in previous step + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/tomcat/#troubleshooting-your-installation) for assistance. + diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/Recommended/tomcat-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/Recommended/tomcat-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/Recommended/tomcat-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/Recommended/tomcat-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/Recommended/tomcat-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/Recommended/tomcat-linuxarm64-recommended-instrumentApplication.md index 5a6c5fb7d8..539f667fb0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/Recommended/tomcat-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/Recommended/tomcat-linuxarm64-recommended-instrumentApplication.md @@ -1,9 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  -### Download otel java binary +### Download otel java binary agent ```bash wget https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/Recommended/tomcat-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/Recommended/tomcat-linuxarm64-recommended-runApplication.md index 49b3656d66..b22f7cc64b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/Recommended/tomcat-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/LinuxARM64/Recommended/tomcat-linuxarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your Java application, you can run it using the below commands ### Step 1: Run OTel Collector @@ -6,15 +8,18 @@ Once you are done intrumenting your Java application, you can run it using the b ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Enable the instrumentation agent and run your application @@ -25,5 +30,10 @@ This should set the environment variable and start sending telemetry data to Sig ```bash export CATALINA_OPTS="$CATALINA_OPTS -javaagent://opentelemetry-javaagent.jar" ``` +  - update it to the path where you downloaded the Java JAR agent in previous step + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/tomcat/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/QuickStart/tomcat-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/QuickStart/tomcat-macosamd64-quickStart-instrumentApplication.md index fe3d25fd84..2fbd471fe1 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/QuickStart/tomcat-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/QuickStart/tomcat-macosamd64-quickStart-instrumentApplication.md @@ -1,5 +1,6 @@ #### Requirements - Java 8 or higher +  ### Download otel java binary agent diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/QuickStart/tomcat-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/QuickStart/tomcat-macosamd64-quickStart-runApplication.md index 1160901c1f..d826a9063c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/QuickStart/tomcat-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/QuickStart/tomcat-macosamd64-quickStart-runApplication.md @@ -1,6 +1,8 @@ -### Enable the instrumentation agent and run your application +## Enable the instrumentation agent and run your application +  If you run your .war package by putting in webapps folder, just add setenv.sh in your Tomcat bin folder. +  This should set these environment variables and start sending telemetry data to SigNoz Cloud. @@ -10,5 +12,11 @@ export OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" export OTEL_EXPORTER_OTLP_ENDPOINT=https://ingest.{{REGION}}.signoz.cloud:443 export OTEL_RESOURCE_ATTRIBUTES=service.name={{MYAPP}} ``` +  - update it to the path where you downloaded the Java JAR agent in previous step + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/tomcat/#troubleshooting-your-installation) for assistance. + diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/Recommended/tomcat-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/Recommended/tomcat-macosamd64-recommended-installOtelCollector.md index ffd03775a4..843e86a411 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/Recommended/tomcat-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/Recommended/tomcat-macosamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ ### 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/Recommended/tomcat-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/Recommended/tomcat-macosamd64-recommended-instrumentApplication.md index 5a6c5fb7d8..539f667fb0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/Recommended/tomcat-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/Recommended/tomcat-macosamd64-recommended-instrumentApplication.md @@ -1,9 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  -### Download otel java binary +### Download otel java binary agent ```bash wget https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/Recommended/tomcat-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/Recommended/tomcat-macosamd64-recommended-runApplication.md index 49b3656d66..b22f7cc64b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/Recommended/tomcat-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsAMD64/Recommended/tomcat-macosamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your Java application, you can run it using the below commands ### Step 1: Run OTel Collector @@ -6,15 +8,18 @@ Once you are done intrumenting your Java application, you can run it using the b ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Enable the instrumentation agent and run your application @@ -25,5 +30,10 @@ This should set the environment variable and start sending telemetry data to Sig ```bash export CATALINA_OPTS="$CATALINA_OPTS -javaagent://opentelemetry-javaagent.jar" ``` +  - update it to the path where you downloaded the Java JAR agent in previous step + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/tomcat/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/QuickStart/tomcat-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/QuickStart/tomcat-macosarm64-quickStart-instrumentApplication.md index fe3d25fd84..2fbd471fe1 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/QuickStart/tomcat-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/QuickStart/tomcat-macosarm64-quickStart-instrumentApplication.md @@ -1,5 +1,6 @@ #### Requirements - Java 8 or higher +  ### Download otel java binary agent diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/QuickStart/tomcat-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/QuickStart/tomcat-macosarm64-quickStart-runApplication.md index 1160901c1f..d826a9063c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/QuickStart/tomcat-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/QuickStart/tomcat-macosarm64-quickStart-runApplication.md @@ -1,6 +1,8 @@ -### Enable the instrumentation agent and run your application +## Enable the instrumentation agent and run your application +  If you run your .war package by putting in webapps folder, just add setenv.sh in your Tomcat bin folder. +  This should set these environment variables and start sending telemetry data to SigNoz Cloud. @@ -10,5 +12,11 @@ export OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" export OTEL_EXPORTER_OTLP_ENDPOINT=https://ingest.{{REGION}}.signoz.cloud:443 export OTEL_RESOURCE_ATTRIBUTES=service.name={{MYAPP}} ``` +  - update it to the path where you downloaded the Java JAR agent in previous step + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/tomcat/#troubleshooting-your-installation) for assistance. + diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/Recommended/tomcat-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/Recommended/tomcat-macosarm64-recommended-installOtelCollector.md index ab4a153670..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/Recommended/tomcat-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/Recommended/tomcat-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/Recommended/tomcat-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/Recommended/tomcat-macosarm64-recommended-instrumentApplication.md index 5a6c5fb7d8..539f667fb0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/Recommended/tomcat-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/Recommended/tomcat-macosarm64-recommended-instrumentApplication.md @@ -1,9 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your Java Application #### Requirements - Java 8 or higher +  -### Download otel java binary +### Download otel java binary agent ```bash wget https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/Recommended/tomcat-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/Recommended/tomcat-macosarm64-recommended-runApplication.md index 49b3656d66..81b2604ca4 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/Recommended/tomcat-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Java/md-docs/Tomcat/MacOsARM64/Recommended/tomcat-macosarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your Java application, you can run it using the below commands ### Step 1: Run OTel Collector @@ -6,15 +8,18 @@ Once you are done intrumenting your Java application, you can run it using the b ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Enable the instrumentation agent and run your application @@ -25,5 +30,10 @@ This should set the environment variable and start sending telemetry data to Sig ```bash export CATALINA_OPTS="$CATALINA_OPTS -javaagent://opentelemetry-javaagent.jar" ``` +  - update it to the path where you downloaded the Java JAR agent in previous step + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/tomcat/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/Kubernetes/express-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/Kubernetes/express-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/Kubernetes/express-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/Kubernetes/express-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/Kubernetes/express-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/Kubernetes/express-kubernetes-instrumentApplication.md index eb61549f28..937c96b814 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/Kubernetes/express-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/Kubernetes/express-kubernetes-instrumentApplication.md @@ -1,8 +1,12 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Supported Versions ^4.0.0 +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -11,6 +15,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/Kubernetes/express-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/Kubernetes/express-kubernetes-runApplication.md index a833498555..45842b329f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/Kubernetes/express-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/Kubernetes/express-kubernetes-runApplication.md @@ -1,5 +1,12 @@ +  + Once you are done intrumenting your JavaScript application, you can run it using the below command ```bash node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/express/#troubleshooting-your-installation) for assistance. + diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/QuickStart/express-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/QuickStart/express-linuxamd64-quickStart-instrumentApplication.md index 549401484e..e60880889c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/QuickStart/express-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/QuickStart/express-linuxamd64-quickStart-instrumentApplication.md @@ -1,6 +1,7 @@ #### Requirements - Supported Versions ^4.0.0 +  ### Step 1: Install OpenTelemetry packages @@ -10,6 +11,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/QuickStart/express-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/QuickStart/express-linuxamd64-quickStart-runApplication.md index ceac5a131f..f5d502f58b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/QuickStart/express-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/QuickStart/express-linuxamd64-quickStart-runApplication.md @@ -1,5 +1,11 @@ +  + Once you are done intrumenting your JavaScript application, you can run it using the below command ```bash OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/express/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/Recommended/express-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/Recommended/express-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/Recommended/express-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/Recommended/express-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/Recommended/express-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/Recommended/express-linuxamd64-recommended-instrumentApplication.md index eb61549f28..aca162869a 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/Recommended/express-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/Recommended/express-linuxamd64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Supported Versions ^4.0.0 +  ### Step 1: Install OpenTelemetry packages @@ -11,6 +12,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/Recommended/express-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/Recommended/express-linuxamd64-recommended-runApplication.md index 2a6b0ed7bd..96ae95ca7f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/Recommended/express-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxAMD64/Recommended/express-linuxamd64-recommended-runApplication.md @@ -1,4 +1,7 @@ +  + Once you are done intrumenting your JavaScript 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 @@ -6,18 +9,25 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/express/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/QuickStart/express-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/QuickStart/express-linuxarm64-quickStart-instrumentApplication.md index 549401484e..e60880889c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/QuickStart/express-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/QuickStart/express-linuxarm64-quickStart-instrumentApplication.md @@ -1,6 +1,7 @@ #### Requirements - Supported Versions ^4.0.0 +  ### Step 1: Install OpenTelemetry packages @@ -10,6 +11,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/QuickStart/express-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/QuickStart/express-linuxarm64-quickStart-runApplication.md index ceac5a131f..f5d502f58b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/QuickStart/express-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/QuickStart/express-linuxarm64-quickStart-runApplication.md @@ -1,5 +1,11 @@ +  + Once you are done intrumenting your JavaScript application, you can run it using the below command ```bash OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/express/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/Recommended/express-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/Recommended/express-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/Recommended/express-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/Recommended/express-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/Recommended/express-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/Recommended/express-linuxarm64-recommended-instrumentApplication.md index eb61549f28..aca162869a 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/Recommended/express-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/Recommended/express-linuxarm64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Supported Versions ^4.0.0 +  ### Step 1: Install OpenTelemetry packages @@ -11,6 +12,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/Recommended/express-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/Recommended/express-linuxarm64-recommended-runApplication.md index 2a6b0ed7bd..96ae95ca7f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/Recommended/express-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/LinuxARM64/Recommended/express-linuxarm64-recommended-runApplication.md @@ -1,4 +1,7 @@ +  + Once you are done intrumenting your JavaScript 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 @@ -6,18 +9,25 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/express/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/QuickStart/express-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/QuickStart/express-macosamd64-quickStart-instrumentApplication.md index 549401484e..e60880889c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/QuickStart/express-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/QuickStart/express-macosamd64-quickStart-instrumentApplication.md @@ -1,6 +1,7 @@ #### Requirements - Supported Versions ^4.0.0 +  ### Step 1: Install OpenTelemetry packages @@ -10,6 +11,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/QuickStart/express-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/QuickStart/express-macosamd64-quickStart-runApplication.md index ceac5a131f..f5d502f58b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/QuickStart/express-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/QuickStart/express-macosamd64-quickStart-runApplication.md @@ -1,5 +1,11 @@ +  + Once you are done intrumenting your JavaScript application, you can run it using the below command ```bash OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/express/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/Recommended/express-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/Recommended/express-macosamd64-recommended-installOtelCollector.md index ffd03775a4..843e86a411 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/Recommended/express-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/Recommended/express-macosamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ ### 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/Recommended/express-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/Recommended/express-macosamd64-recommended-instrumentApplication.md index eb61549f28..aca162869a 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/Recommended/express-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/Recommended/express-macosamd64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Supported Versions ^4.0.0 +  ### Step 1: Install OpenTelemetry packages @@ -11,6 +12,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/Recommended/express-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/Recommended/express-macosamd64-recommended-runApplication.md index 2a6b0ed7bd..96ae95ca7f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/Recommended/express-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsAMD64/Recommended/express-macosamd64-recommended-runApplication.md @@ -1,4 +1,7 @@ +  + Once you are done intrumenting your JavaScript 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 @@ -6,18 +9,25 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/express/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/QuickStart/express-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/QuickStart/express-macosarm64-quickStart-instrumentApplication.md index 549401484e..e60880889c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/QuickStart/express-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/QuickStart/express-macosarm64-quickStart-instrumentApplication.md @@ -1,6 +1,7 @@ #### Requirements - Supported Versions ^4.0.0 +  ### Step 1: Install OpenTelemetry packages @@ -10,6 +11,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/QuickStart/express-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/QuickStart/express-macosarm64-quickStart-runApplication.md index ceac5a131f..f5d502f58b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/QuickStart/express-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/QuickStart/express-macosarm64-quickStart-runApplication.md @@ -1,5 +1,11 @@ +  + Once you are done intrumenting your JavaScript application, you can run it using the below command ```bash OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/express/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/Recommended/express-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/Recommended/express-macosarm64-recommended-installOtelCollector.md index ab4a153670..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/Recommended/express-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/Recommended/express-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/Recommended/express-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/Recommended/express-macosarm64-recommended-instrumentApplication.md index eb61549f28..aca162869a 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/Recommended/express-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/Recommended/express-macosarm64-recommended-instrumentApplication.md @@ -1,7 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Supported Versions ^4.0.0 +  ### Step 1: Install OpenTelemetry packages @@ -11,6 +12,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/Recommended/express-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/Recommended/express-macosarm64-recommended-runApplication.md index 2a6b0ed7bd..96ae95ca7f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/Recommended/express-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/Express/MacOsARM64/Recommended/express-macosarm64-recommended-runApplication.md @@ -1,4 +1,7 @@ +  + Once you are done intrumenting your JavaScript 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 @@ -6,18 +9,25 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/express/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/Kubernetes/nestjs-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/Kubernetes/nestjs-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/Kubernetes/nestjs-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/Kubernetes/nestjs-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/Kubernetes/nestjs-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/Kubernetes/nestjs-kubernetes-instrumentApplication.md index 99cdef99ad..d79efc0346 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/Kubernetes/nestjs-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/Kubernetes/nestjs-kubernetes-instrumentApplication.md @@ -1,7 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Supported Versions >= `4.0.0` +  ### Step 1: Install OpenTelemetry packages @@ -11,6 +14,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file @@ -53,6 +57,7 @@ process.on('SIGTERM', () => { export default sdk; ``` +  ### Step 3: Import tracer in the `main.js file` @@ -60,6 +65,7 @@ export default sdk; ```bash const tracer = require('./tracer') ``` +  ### Step 4: Start the tracer In the `async function boostrap` section of the application code, initialize the tracer as follows: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/Kubernetes/nestjs-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/Kubernetes/nestjs-kubernetes-runApplication.md index 1f71517adb..d5f3b185cc 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/Kubernetes/nestjs-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/Kubernetes/nestjs-kubernetes-runApplication.md @@ -2,4 +2,8 @@ After your instrumentation is done, start your application ```bash nest start -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/nestjs/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/QuickStart/nestjs-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/QuickStart/nestjs-linuxamd64-quickStart-instrumentApplication.md index 40fb309d2c..4a874e0f36 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/QuickStart/nestjs-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/QuickStart/nestjs-linuxamd64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Supported Versions >= `4.0.0` +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -9,6 +11,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file @@ -51,6 +54,7 @@ process.on('SIGTERM', () => { export default sdk; ``` +  ### Step 3: Import tracer in the `main.js file` @@ -58,6 +62,7 @@ export default sdk; ```bash const tracer = require('./tracer') ``` +  ### Step 4: Start the tracer In the `async function boostrap` section of the application code, initialize the tracer as follows: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/QuickStart/nestjs-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/QuickStart/nestjs-linuxamd64-quickStart-runApplication.md index d3e15c4cc9..c3b07c5251 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/QuickStart/nestjs-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/QuickStart/nestjs-linuxamd64-quickStart-runApplication.md @@ -2,4 +2,8 @@ After your instrumentation is done, start your application ```bash OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" nest start -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/nestjs/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/Recommended/nestjs-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/Recommended/nestjs-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/Recommended/nestjs-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/Recommended/nestjs-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/Recommended/nestjs-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/Recommended/nestjs-linuxamd64-recommended-instrumentApplication.md index 99cdef99ad..d79efc0346 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/Recommended/nestjs-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/Recommended/nestjs-linuxamd64-recommended-instrumentApplication.md @@ -1,7 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Supported Versions >= `4.0.0` +  ### Step 1: Install OpenTelemetry packages @@ -11,6 +14,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file @@ -53,6 +57,7 @@ process.on('SIGTERM', () => { export default sdk; ``` +  ### Step 3: Import tracer in the `main.js file` @@ -60,6 +65,7 @@ export default sdk; ```bash const tracer = require('./tracer') ``` +  ### Step 4: Start the tracer In the `async function boostrap` section of the application code, initialize the tracer as follows: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/Recommended/nestjs-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/Recommended/nestjs-linuxamd64-recommended-runApplication.md index c08d2b7d2f..314d77460c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/Recommended/nestjs-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxAMD64/Recommended/nestjs-linuxamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your JavaScript application, you can run it using the below commands ### Step 1: Run OTel Collector @@ -6,17 +8,24 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash nest start -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/nestjs/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/QuickStart/nestjs-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/QuickStart/nestjs-linuxarm64-quickStart-instrumentApplication.md index 40fb309d2c..4a874e0f36 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/QuickStart/nestjs-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/QuickStart/nestjs-linuxarm64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Supported Versions >= `4.0.0` +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -9,6 +11,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file @@ -51,6 +54,7 @@ process.on('SIGTERM', () => { export default sdk; ``` +  ### Step 3: Import tracer in the `main.js file` @@ -58,6 +62,7 @@ export default sdk; ```bash const tracer = require('./tracer') ``` +  ### Step 4: Start the tracer In the `async function boostrap` section of the application code, initialize the tracer as follows: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/QuickStart/nestjs-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/QuickStart/nestjs-linuxarm64-quickStart-runApplication.md index d3e15c4cc9..c3b07c5251 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/QuickStart/nestjs-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/QuickStart/nestjs-linuxarm64-quickStart-runApplication.md @@ -2,4 +2,8 @@ After your instrumentation is done, start your application ```bash OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" nest start -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/nestjs/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/Recommended/nestjs-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/Recommended/nestjs-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/Recommended/nestjs-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/Recommended/nestjs-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/Recommended/nestjs-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/Recommended/nestjs-linuxarm64-recommended-instrumentApplication.md index 99cdef99ad..d79efc0346 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/Recommended/nestjs-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/Recommended/nestjs-linuxarm64-recommended-instrumentApplication.md @@ -1,7 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Supported Versions >= `4.0.0` +  ### Step 1: Install OpenTelemetry packages @@ -11,6 +14,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file @@ -53,6 +57,7 @@ process.on('SIGTERM', () => { export default sdk; ``` +  ### Step 3: Import tracer in the `main.js file` @@ -60,6 +65,7 @@ export default sdk; ```bash const tracer = require('./tracer') ``` +  ### Step 4: Start the tracer In the `async function boostrap` section of the application code, initialize the tracer as follows: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/Recommended/nestjs-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/Recommended/nestjs-linuxarm64-recommended-runApplication.md index c08d2b7d2f..314d77460c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/Recommended/nestjs-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/LinuxARM64/Recommended/nestjs-linuxarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your JavaScript application, you can run it using the below commands ### Step 1: Run OTel Collector @@ -6,17 +8,24 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash nest start -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/nestjs/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/QuickStart/nestjs-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/QuickStart/nestjs-macosamd64-quickStart-instrumentApplication.md index 40fb309d2c..4a874e0f36 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/QuickStart/nestjs-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/QuickStart/nestjs-macosamd64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Supported Versions >= `4.0.0` +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -9,6 +11,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file @@ -51,6 +54,7 @@ process.on('SIGTERM', () => { export default sdk; ``` +  ### Step 3: Import tracer in the `main.js file` @@ -58,6 +62,7 @@ export default sdk; ```bash const tracer = require('./tracer') ``` +  ### Step 4: Start the tracer In the `async function boostrap` section of the application code, initialize the tracer as follows: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/QuickStart/nestjs-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/QuickStart/nestjs-macosamd64-quickStart-runApplication.md index d3e15c4cc9..c3b07c5251 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/QuickStart/nestjs-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/QuickStart/nestjs-macosamd64-quickStart-runApplication.md @@ -2,4 +2,8 @@ After your instrumentation is done, start your application ```bash OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" nest start -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/nestjs/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/Recommended/nestjs-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/Recommended/nestjs-macosamd64-recommended-installOtelCollector.md index ffd03775a4..843e86a411 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/Recommended/nestjs-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/Recommended/nestjs-macosamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ ### 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/Recommended/nestjs-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/Recommended/nestjs-macosamd64-recommended-instrumentApplication.md index 99cdef99ad..d79efc0346 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/Recommended/nestjs-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/Recommended/nestjs-macosamd64-recommended-instrumentApplication.md @@ -1,7 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Supported Versions >= `4.0.0` +  ### Step 1: Install OpenTelemetry packages @@ -11,6 +14,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file @@ -53,6 +57,7 @@ process.on('SIGTERM', () => { export default sdk; ``` +  ### Step 3: Import tracer in the `main.js file` @@ -60,6 +65,7 @@ export default sdk; ```bash const tracer = require('./tracer') ``` +  ### Step 4: Start the tracer In the `async function boostrap` section of the application code, initialize the tracer as follows: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/Recommended/nestjs-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/Recommended/nestjs-macosamd64-recommended-runApplication.md index c08d2b7d2f..314d77460c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/Recommended/nestjs-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsAMD64/Recommended/nestjs-macosamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your JavaScript application, you can run it using the below commands ### Step 1: Run OTel Collector @@ -6,17 +8,24 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash nest start -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/nestjs/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/QuickStart/nestjs-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/QuickStart/nestjs-macosarm64-quickStart-instrumentApplication.md index 40fb309d2c..4a874e0f36 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/QuickStart/nestjs-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/QuickStart/nestjs-macosarm64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Supported Versions >= `4.0.0` +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -9,6 +11,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file @@ -51,6 +54,7 @@ process.on('SIGTERM', () => { export default sdk; ``` +  ### Step 3: Import tracer in the `main.js file` @@ -58,6 +62,7 @@ export default sdk; ```bash const tracer = require('./tracer') ``` +  ### Step 4: Start the tracer In the `async function boostrap` section of the application code, initialize the tracer as follows: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/QuickStart/nestjs-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/QuickStart/nestjs-macosarm64-quickStart-runApplication.md index d3e15c4cc9..c3b07c5251 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/QuickStart/nestjs-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/QuickStart/nestjs-macosarm64-quickStart-runApplication.md @@ -2,4 +2,8 @@ After your instrumentation is done, start your application ```bash OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" nest start -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/nestjs/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/Recommended/nestjs-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/Recommended/nestjs-macosarm64-recommended-installOtelCollector.md index ab4a153670..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/Recommended/nestjs-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/Recommended/nestjs-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/Recommended/nestjs-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/Recommended/nestjs-macosarm64-recommended-instrumentApplication.md index 99cdef99ad..d79efc0346 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/Recommended/nestjs-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/Recommended/nestjs-macosarm64-recommended-instrumentApplication.md @@ -1,7 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - Supported Versions >= `4.0.0` +  ### Step 1: Install OpenTelemetry packages @@ -11,6 +14,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file @@ -53,6 +57,7 @@ process.on('SIGTERM', () => { export default sdk; ``` +  ### Step 3: Import tracer in the `main.js file` @@ -60,6 +65,7 @@ export default sdk; ```bash const tracer = require('./tracer') ``` +  ### Step 4: Start the tracer In the `async function boostrap` section of the application code, initialize the tracer as follows: diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/Recommended/nestjs-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/Recommended/nestjs-macosarm64-recommended-runApplication.md index c08d2b7d2f..314d77460c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/Recommended/nestjs-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NestJS/MacOsARM64/Recommended/nestjs-macosarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your JavaScript application, you can run it using the below commands ### Step 1: Run OTel Collector @@ -6,17 +8,24 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash nest start -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/nestjs/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/Kubernetes/nodejs-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/Kubernetes/nodejs-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/Kubernetes/nodejs-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/Kubernetes/nodejs-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/Kubernetes/nodejs-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/Kubernetes/nodejs-kubernetes-instrumentApplication.md index c7912b56a4..bdf2a856f4 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/Kubernetes/nodejs-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/Kubernetes/nodejs-kubernetes-instrumentApplication.md @@ -1,7 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - NodeJS Version 14 or newer +  ### Step 1: Install OpenTelemetry packages @@ -11,6 +14,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/Kubernetes/nodejs-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/Kubernetes/nodejs-kubernetes-runApplication.md index a833498555..3f799989f9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/Kubernetes/nodejs-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/Kubernetes/nodejs-kubernetes-runApplication.md @@ -2,4 +2,8 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/javascript/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/QuickStart/nodejs-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/QuickStart/nodejs-linuxamd64-quickStart-instrumentApplication.md index 57f792ac01..ed6f8a0180 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/QuickStart/nodejs-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/QuickStart/nodejs-linuxamd64-quickStart-instrumentApplication.md @@ -2,6 +2,8 @@ #### Requirements - NodeJS Version 14 or newer +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -10,6 +12,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/QuickStart/nodejs-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/QuickStart/nodejs-linuxamd64-quickStart-runApplication.md index ceac5a131f..c2c9a9566b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/QuickStart/nodejs-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/QuickStart/nodejs-linuxamd64-quickStart-runApplication.md @@ -2,4 +2,8 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/javascript/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/Recommended/nodejs-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/Recommended/nodejs-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/Recommended/nodejs-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/Recommended/nodejs-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/Recommended/nodejs-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/Recommended/nodejs-linuxamd64-recommended-instrumentApplication.md index c7912b56a4..8fa26346f0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/Recommended/nodejs-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/Recommended/nodejs-linuxamd64-recommended-instrumentApplication.md @@ -1,8 +1,12 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - NodeJS Version 14 or newer +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -11,6 +15,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/Recommended/nodejs-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/Recommended/nodejs-linuxamd64-recommended-runApplication.md index d2e6728955..278e43f58c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/Recommended/nodejs-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxAMD64/Recommended/nodejs-linuxamd64-recommended-runApplication.md @@ -1,4 +1,7 @@ +  + Once you are done intrumenting your JavaScript 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 @@ -6,17 +9,24 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/javascript/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/QuickStart/nodejs-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/QuickStart/nodejs-linuxarm64-quickStart-instrumentApplication.md index 57f792ac01..ed6f8a0180 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/QuickStart/nodejs-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/QuickStart/nodejs-linuxarm64-quickStart-instrumentApplication.md @@ -2,6 +2,8 @@ #### Requirements - NodeJS Version 14 or newer +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -10,6 +12,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/QuickStart/nodejs-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/QuickStart/nodejs-linuxarm64-quickStart-runApplication.md index ceac5a131f..c2c9a9566b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/QuickStart/nodejs-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/QuickStart/nodejs-linuxarm64-quickStart-runApplication.md @@ -2,4 +2,8 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/javascript/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/Recommended/nodejs-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/Recommended/nodejs-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/Recommended/nodejs-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/Recommended/nodejs-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/Recommended/nodejs-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/Recommended/nodejs-linuxarm64-recommended-instrumentApplication.md index c7912b56a4..8fa26346f0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/Recommended/nodejs-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/Recommended/nodejs-linuxarm64-recommended-instrumentApplication.md @@ -1,8 +1,12 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - NodeJS Version 14 or newer +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -11,6 +15,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/Recommended/nodejs-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/Recommended/nodejs-linuxarm64-recommended-runApplication.md index d2e6728955..278e43f58c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/Recommended/nodejs-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/LinuxARM64/Recommended/nodejs-linuxarm64-recommended-runApplication.md @@ -1,4 +1,7 @@ +  + Once you are done intrumenting your JavaScript 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 @@ -6,17 +9,24 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/javascript/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/QuickStart/nodejs-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/QuickStart/nodejs-macosamd64-quickStart-instrumentApplication.md index 57f792ac01..ed6f8a0180 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/QuickStart/nodejs-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/QuickStart/nodejs-macosamd64-quickStart-instrumentApplication.md @@ -2,6 +2,8 @@ #### Requirements - NodeJS Version 14 or newer +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -10,6 +12,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/QuickStart/nodejs-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/QuickStart/nodejs-macosamd64-quickStart-runApplication.md index ceac5a131f..c2c9a9566b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/QuickStart/nodejs-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/QuickStart/nodejs-macosamd64-quickStart-runApplication.md @@ -2,4 +2,8 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/javascript/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/Recommended/nodejs-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/Recommended/nodejs-macosamd64-recommended-installOtelCollector.md index ffd03775a4..d79efc0346 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/Recommended/nodejs-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/Recommended/nodejs-macosamd64-recommended-installOtelCollector.md @@ -1,93 +1,87 @@ -### Setup OpenTelemetry Binary as an agent +  + +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application + +#### Requirements +- Supported Versions >= `4.0.0` +  + +### Step 1: Install OpenTelemetry packages -### 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_darwin_amd64.tar.gz +npm install --save @opentelemetry/api@^1.6.0 +npm install --save @opentelemetry/sdk-node@^0.45.0 +npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 +npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  + +### Step 2: Create tracing.js file -### Step 2: Extract otel-collector tar.gz to the `otelcol-contrib` folder ```bash -mkdir otelcol-contrib && tar xvzf otelcol-contrib_0.79.0_darwin_amd64.tar.gz -C otelcol-contrib -``` +'use strict'; -### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it +import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node'; +import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http'; +import { Resource } from '@opentelemetry/resources'; +import * as opentelemetry from '@opentelemetry/sdk-node'; +import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'; + +// Configure the SDK to export telemetry data to the console +// Enable all auto-instrumentations from the meta package +const exporterOptions = { + url: 'http://localhost:4318/v1/traces', +}; + +const traceExporter = new OTLPTraceExporter(exporterOptions); +const sdk = new opentelemetry.NodeSDK({ + traceExporter, + instrumentations: [getNodeAutoInstrumentations()], + resource: new Resource({ + [SemanticResourceAttributes.SERVICE_NAME]: '{{MYAPP}}', + }), +}); + +// initialize the SDK and register with the OpenTelemetry API +// this enables the API to record telemetry +sdk.start(); + +// gracefully shut down the SDK on process exit +process.on('SIGTERM', () => { + sdk + .shutdown() + .then(() => console.log('Tracing terminated')) + .catch((error) => console.log('Error terminating tracing', error)) + .finally(() => process.exit(0)); +}); + +export default sdk; +``` +  + +### Step 3: Import tracer in the `main.js file` + +**Important Note**: The below import should be the first line in the main file of your application (Ex -> `main.ts`) ```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] +const tracer = require('./tracer') ``` +  +### Step 4: Start the tracer +In the `async function boostrap` section of the application code, initialize the tracer as follows: +```bash +const tracer = require('./tracer') + +import { NestFactory } from '@nestjs/core'; +import { AppModule } from './app.module'; + // All of your application code and any imports that should leverage + // OpenTelemetry automatic instrumentation must go here. + +async function bootstrap() { + await tracer.start(); + const app = await NestFactory.create(AppModule); + await app.listen(3001); + } + bootstrap(); +``` \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/Recommended/nodejs-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/Recommended/nodejs-macosamd64-recommended-instrumentApplication.md index c7912b56a4..8fa26346f0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/Recommended/nodejs-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/Recommended/nodejs-macosamd64-recommended-instrumentApplication.md @@ -1,8 +1,12 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - NodeJS Version 14 or newer +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -11,6 +15,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/Recommended/nodejs-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/Recommended/nodejs-macosamd64-recommended-runApplication.md index d2e6728955..278e43f58c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/Recommended/nodejs-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsAMD64/Recommended/nodejs-macosamd64-recommended-runApplication.md @@ -1,4 +1,7 @@ +  + Once you are done intrumenting your JavaScript 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 @@ -6,17 +9,24 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/javascript/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/QuickStart/nodejs-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/QuickStart/nodejs-macosarm64-quickStart-instrumentApplication.md index 57f792ac01..ed6f8a0180 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/QuickStart/nodejs-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/QuickStart/nodejs-macosarm64-quickStart-instrumentApplication.md @@ -2,6 +2,8 @@ #### Requirements - NodeJS Version 14 or newer +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -10,6 +12,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/QuickStart/nodejs-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/QuickStart/nodejs-macosarm64-quickStart-runApplication.md index ceac5a131f..c2c9a9566b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/QuickStart/nodejs-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/QuickStart/nodejs-macosarm64-quickStart-runApplication.md @@ -2,4 +2,8 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash OTEL_EXPORTER_OTLP_HEADERS="signoz-access-token={{SIGNOZ_INGESTION_KEY}}" node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/javascript/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/Recommended/nodejs-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/Recommended/nodejs-macosarm64-recommended-installOtelCollector.md index ab4a153670..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/Recommended/nodejs-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/Recommended/nodejs-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/Recommended/nodejs-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/Recommended/nodejs-macosarm64-recommended-instrumentApplication.md index c7912b56a4..8fa26346f0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/Recommended/nodejs-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/Recommended/nodejs-macosarm64-recommended-instrumentApplication.md @@ -1,8 +1,12 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your JavaScript Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your JavaScript Application #### Requirements - NodeJS Version 14 or newer +  + ### Step 1: Install OpenTelemetry packages ```bash @@ -11,6 +15,7 @@ npm install --save @opentelemetry/sdk-node@^0.45.0 npm install --save @opentelemetry/auto-instrumentations-node@^0.39.4 npm install --save @opentelemetry/exporter-trace-otlp-http@^0.45.0 ``` +  ### Step 2: Create tracing.js file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/Recommended/nodejs-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/Recommended/nodejs-macosarm64-recommended-runApplication.md index d2e6728955..278e43f58c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/Recommended/nodejs-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Javascript/md-docs/NodeJS/MacOsARM64/Recommended/nodejs-macosarm64-recommended-runApplication.md @@ -1,4 +1,7 @@ +  + Once you are done intrumenting your JavaScript 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 @@ -6,17 +9,24 @@ Once you are done intrumenting your JavaScript application, you can run it using ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash node -r ./tracing.js app.js -``` \ No newline at end of file +``` + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/javascript/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/Kubernetes/django-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/Kubernetes/django-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/Kubernetes/django-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/Kubernetes/django-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/Kubernetes/django-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/Kubernetes/django-kubernetes-instrumentApplication.md index 24c74573cf..3dd7818ff9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/Kubernetes/django-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/Kubernetes/django-kubernetes-instrumentApplication.md @@ -1,4 +1,6 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer @@ -6,6 +8,7 @@ After setting up the Otel collector agent, follow the steps below to instrumnet ```bash export DJANGO_SETTINGS_MODULE=mysite.settings ``` +  ### Step 1 : Create a virtual environment @@ -15,12 +18,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/Kubernetes/django-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/Kubernetes/django-kubernetes-runApplication.md index 0dac08576a..b4e0804971 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/Kubernetes/django-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/Kubernetes/django-kubernetes-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using this command ```bash @@ -8,8 +10,14 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` - In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/django/#troubleshooting-your-installation) for assistance. + diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/QuickStart/django-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/QuickStart/django-linuxamd64-quickStart-instrumentApplication.md index 34349b4500..14b9fb2da6 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/QuickStart/django-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/QuickStart/django-linuxamd64-quickStart-instrumentApplication.md @@ -4,6 +4,7 @@ ```bash export DJANGO_SETTINGS_MODULE=mysite.settings ``` +  ### Step 1 : Create a virtual environment @@ -13,18 +14,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/QuickStart/django-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/QuickStart/django-linuxamd64-quickStart-runApplication.md index b653ab83da..2a035909dd 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/QuickStart/django-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/QuickStart/django-linuxamd64-quickStart-runApplication.md @@ -10,5 +10,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/django/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/Recommended/django-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/Recommended/django-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/Recommended/django-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/Recommended/django-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/Recommended/django-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/Recommended/django-linuxamd64-recommended-instrumentApplication.md index 24c74573cf..3dd7818ff9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/Recommended/django-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/Recommended/django-linuxamd64-recommended-instrumentApplication.md @@ -1,4 +1,6 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer @@ -6,6 +8,7 @@ After setting up the Otel collector agent, follow the steps below to instrumnet ```bash export DJANGO_SETTINGS_MODULE=mysite.settings ``` +  ### Step 1 : Create a virtual environment @@ -15,12 +18,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/Recommended/django-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/Recommended/django-linuxamd64-recommended-runApplication.md index 499111ed4f..80c4216c1c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/Recommended/django-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxAMD64/Recommended/django-linuxamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -6,28 +8,37 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash -OTEL_RESOURCE_ATTRIBUTES=service.name= \ +OTEL_RESOURCE_ATTRIBUTES=service.name={{MYAPP}} \ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317" \ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` + `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/django/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/QuickStart/django-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/QuickStart/django-linuxarm64-quickStart-instrumentApplication.md index 34349b4500..14b9fb2da6 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/QuickStart/django-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/QuickStart/django-linuxarm64-quickStart-instrumentApplication.md @@ -4,6 +4,7 @@ ```bash export DJANGO_SETTINGS_MODULE=mysite.settings ``` +  ### Step 1 : Create a virtual environment @@ -13,18 +14,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/QuickStart/django-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/QuickStart/django-linuxarm64-quickStart-runApplication.md index b653ab83da..2a035909dd 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/QuickStart/django-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/QuickStart/django-linuxarm64-quickStart-runApplication.md @@ -10,5 +10,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/django/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/Recommended/django-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/Recommended/django-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/Recommended/django-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/Recommended/django-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/Recommended/django-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/Recommended/django-linuxarm64-recommended-instrumentApplication.md index 24c74573cf..3dd7818ff9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/Recommended/django-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/Recommended/django-linuxarm64-recommended-instrumentApplication.md @@ -1,4 +1,6 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer @@ -6,6 +8,7 @@ After setting up the Otel collector agent, follow the steps below to instrumnet ```bash export DJANGO_SETTINGS_MODULE=mysite.settings ``` +  ### Step 1 : Create a virtual environment @@ -15,12 +18,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/Recommended/django-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/Recommended/django-linuxarm64-recommended-runApplication.md index 499111ed4f..80c4216c1c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/Recommended/django-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/LinuxARM64/Recommended/django-linuxarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -6,28 +8,37 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash -OTEL_RESOURCE_ATTRIBUTES=service.name= \ +OTEL_RESOURCE_ATTRIBUTES=service.name={{MYAPP}} \ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317" \ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` + `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/django/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/QuickStart/django-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/QuickStart/django-macosamd64-quickStart-instrumentApplication.md index 34349b4500..14b9fb2da6 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/QuickStart/django-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/QuickStart/django-macosamd64-quickStart-instrumentApplication.md @@ -4,6 +4,7 @@ ```bash export DJANGO_SETTINGS_MODULE=mysite.settings ``` +  ### Step 1 : Create a virtual environment @@ -13,18 +14,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/QuickStart/django-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/QuickStart/django-macosamd64-quickStart-runApplication.md index b653ab83da..2a035909dd 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/QuickStart/django-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/QuickStart/django-macosamd64-quickStart-runApplication.md @@ -10,5 +10,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/django/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/Recommended/django-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/Recommended/django-macosamd64-recommended-installOtelCollector.md index ffd03775a4..843e86a411 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/Recommended/django-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/Recommended/django-macosamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ ### 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/Recommended/django-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/Recommended/django-macosamd64-recommended-instrumentApplication.md index 24c74573cf..3dd7818ff9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/Recommended/django-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/Recommended/django-macosamd64-recommended-instrumentApplication.md @@ -1,4 +1,6 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer @@ -6,6 +8,7 @@ After setting up the Otel collector agent, follow the steps below to instrumnet ```bash export DJANGO_SETTINGS_MODULE=mysite.settings ``` +  ### Step 1 : Create a virtual environment @@ -15,12 +18,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/Recommended/django-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/Recommended/django-macosamd64-recommended-runApplication.md index 499111ed4f..80c4216c1c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/Recommended/django-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsAMD64/Recommended/django-macosamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -6,28 +8,37 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash -OTEL_RESOURCE_ATTRIBUTES=service.name= \ +OTEL_RESOURCE_ATTRIBUTES=service.name={{MYAPP}} \ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317" \ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` + `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/django/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/QuickStart/django-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/QuickStart/django-macosarm64-quickStart-instrumentApplication.md index 34349b4500..14b9fb2da6 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/QuickStart/django-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/QuickStart/django-macosarm64-quickStart-instrumentApplication.md @@ -4,6 +4,7 @@ ```bash export DJANGO_SETTINGS_MODULE=mysite.settings ``` +  ### Step 1 : Create a virtual environment @@ -13,18 +14,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/QuickStart/django-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/QuickStart/django-macosarm64-quickStart-runApplication.md index b653ab83da..2a035909dd 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/QuickStart/django-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/QuickStart/django-macosarm64-quickStart-runApplication.md @@ -10,5 +10,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/django/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/Recommended/django-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/Recommended/django-macosarm64-recommended-installOtelCollector.md index f9dd7bc077..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/Recommended/django-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/Recommended/django-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/Recommended/django-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/Recommended/django-macosarm64-recommended-instrumentApplication.md index 24c74573cf..3dd7818ff9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/Recommended/django-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/Recommended/django-macosarm64-recommended-instrumentApplication.md @@ -1,4 +1,6 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer @@ -6,6 +8,7 @@ After setting up the Otel collector agent, follow the steps below to instrumnet ```bash export DJANGO_SETTINGS_MODULE=mysite.settings ``` +  ### Step 1 : Create a virtual environment @@ -15,12 +18,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/Recommended/django-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/Recommended/django-macosarm64-recommended-runApplication.md index 499111ed4f..80c4216c1c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/Recommended/django-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Django/MacOsARM64/Recommended/django-macosarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -6,28 +8,37 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash -OTEL_RESOURCE_ATTRIBUTES=service.name= \ +OTEL_RESOURCE_ATTRIBUTES=service.name={{MYAPP}} \ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317" \ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` + `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/django/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/Kubernetes/falcon-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/Kubernetes/falcon-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/Kubernetes/falcon-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/Kubernetes/falcon-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/Kubernetes/falcon-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/Kubernetes/falcon-kubernetes-instrumentApplication.md index 824cf2dc84..bf78da14dd 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/Kubernetes/falcon-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/Kubernetes/falcon-kubernetes-instrumentApplication.md @@ -1,7 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer +  ### Step 1 : Create a virtual environment @@ -11,18 +14,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/Kubernetes/falcon-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/Kubernetes/falcon-kubernetes-runApplication.md index 0dac08576a..491e5fe3ea 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/Kubernetes/falcon-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/Kubernetes/falcon-kubernetes-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using this command ```bash @@ -8,8 +10,13 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` - In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/falcon/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/QuickStart/falcon-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/QuickStart/falcon-linuxamd64-quickStart-instrumentApplication.md index 5b65a16006..103474a27e 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/QuickStart/falcon-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/QuickStart/falcon-linuxamd64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/QuickStart/falcon-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/QuickStart/falcon-linuxamd64-quickStart-runApplication.md index db8c80d0aa..81f33cc42b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/QuickStart/falcon-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/QuickStart/falcon-linuxamd64-quickStart-runApplication.md @@ -10,5 +10,12 @@ opentelemetry-instrument `` can be `python3 app.py` or `gunicorn src.app -b 0.0.0.0:8001` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/falcon/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/Recommended/falcon-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/Recommended/falcon-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/Recommended/falcon-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/Recommended/falcon-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/Recommended/falcon-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/Recommended/falcon-linuxamd64-recommended-instrumentApplication.md index 824cf2dc84..bf78da14dd 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/Recommended/falcon-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/Recommended/falcon-linuxamd64-recommended-instrumentApplication.md @@ -1,7 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer +  ### Step 1 : Create a virtual environment @@ -11,18 +14,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/Recommended/falcon-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/Recommended/falcon-linuxamd64-recommended-runApplication.md index ba24810ae1..ff48189545 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/Recommended/falcon-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxAMD64/Recommended/falcon-linuxamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using these commands ### Step 1: Run OTel Collector @@ -6,15 +8,18 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash @@ -24,9 +29,13 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `flask run` +  **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` - In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/falcon/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/QuickStart/falcon-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/QuickStart/falcon-linuxarm64-quickStart-instrumentApplication.md index 5b65a16006..103474a27e 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/QuickStart/falcon-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/QuickStart/falcon-linuxarm64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/QuickStart/falcon-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/QuickStart/falcon-linuxarm64-quickStart-runApplication.md index db8c80d0aa..81f33cc42b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/QuickStart/falcon-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/QuickStart/falcon-linuxarm64-quickStart-runApplication.md @@ -10,5 +10,12 @@ opentelemetry-instrument `` can be `python3 app.py` or `gunicorn src.app -b 0.0.0.0:8001` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/falcon/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/Recommended/falcon-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/Recommended/falcon-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/Recommended/falcon-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/Recommended/falcon-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/Recommended/falcon-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/Recommended/falcon-linuxarm64-recommended-instrumentApplication.md index 824cf2dc84..bf78da14dd 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/Recommended/falcon-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/Recommended/falcon-linuxarm64-recommended-instrumentApplication.md @@ -1,7 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer +  ### Step 1 : Create a virtual environment @@ -11,18 +14,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/Recommended/falcon-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/Recommended/falcon-linuxarm64-recommended-runApplication.md index ba24810ae1..ff48189545 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/Recommended/falcon-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/LinuxARM64/Recommended/falcon-linuxarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using these commands ### Step 1: Run OTel Collector @@ -6,15 +8,18 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash @@ -24,9 +29,13 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `flask run` +  **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` - In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/falcon/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/QuickStart/falcon-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/QuickStart/falcon-macosamd64-quickStart-instrumentApplication.md index 5b65a16006..103474a27e 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/QuickStart/falcon-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/QuickStart/falcon-macosamd64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/QuickStart/falcon-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/QuickStart/falcon-macosamd64-quickStart-runApplication.md index db8c80d0aa..81f33cc42b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/QuickStart/falcon-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/QuickStart/falcon-macosamd64-quickStart-runApplication.md @@ -10,5 +10,12 @@ opentelemetry-instrument `` can be `python3 app.py` or `gunicorn src.app -b 0.0.0.0:8001` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/falcon/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/Recommended/falcon-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/Recommended/falcon-macosamd64-recommended-installOtelCollector.md index ffd03775a4..843e86a411 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/Recommended/falcon-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/Recommended/falcon-macosamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ ### 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/Recommended/falcon-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/Recommended/falcon-macosamd64-recommended-instrumentApplication.md index 824cf2dc84..bf78da14dd 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/Recommended/falcon-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/Recommended/falcon-macosamd64-recommended-instrumentApplication.md @@ -1,7 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer +  ### Step 1 : Create a virtual environment @@ -11,18 +14,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/Recommended/falcon-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/Recommended/falcon-macosamd64-recommended-runApplication.md index ba24810ae1..ff48189545 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/Recommended/falcon-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsAMD64/Recommended/falcon-macosamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using these commands ### Step 1: Run OTel Collector @@ -6,15 +8,18 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash @@ -24,9 +29,13 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `flask run` +  **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` - In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/falcon/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/QuickStart/falcon-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/QuickStart/falcon-macosarm64-quickStart-instrumentApplication.md index 5b65a16006..103474a27e 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/QuickStart/falcon-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/QuickStart/falcon-macosarm64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/QuickStart/falcon-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/QuickStart/falcon-macosarm64-quickStart-runApplication.md index db8c80d0aa..81f33cc42b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/QuickStart/falcon-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/QuickStart/falcon-macosarm64-quickStart-runApplication.md @@ -10,5 +10,12 @@ opentelemetry-instrument `` can be `python3 app.py` or `gunicorn src.app -b 0.0.0.0:8001` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/falcon/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/Recommended/falcon-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/Recommended/falcon-macosarm64-recommended-installOtelCollector.md index f9dd7bc077..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/Recommended/falcon-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/Recommended/falcon-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/Recommended/falcon-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/Recommended/falcon-macosarm64-recommended-instrumentApplication.md index 824cf2dc84..bf78da14dd 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/Recommended/falcon-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/Recommended/falcon-macosarm64-recommended-instrumentApplication.md @@ -1,7 +1,10 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer +  ### Step 1 : Create a virtual environment @@ -11,18 +14,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/Recommended/falcon-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/Recommended/falcon-macosarm64-recommended-runApplication.md index ba24810ae1..b567607064 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/Recommended/falcon-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Falcon/MacOsARM64/Recommended/falcon-macosarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using these commands ### Step 1: Run OTel Collector @@ -6,15 +8,18 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash @@ -24,9 +29,14 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `flask run` +  **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` - In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/falcon/#troubleshooting-your-installation) for assistance. + diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/Kubernetes/fastapi-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/Kubernetes/fastapi-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/Kubernetes/fastapi-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/Kubernetes/fastapi-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/Kubernetes/fastapi-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/Kubernetes/fastapi-kubernetes-instrumentApplication.md index c8f0f9df39..f0420aa305 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/Kubernetes/fastapi-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/Kubernetes/fastapi-kubernetes-instrumentApplication.md @@ -1,8 +1,12 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -11,18 +15,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/Kubernetes/fastapi-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/Kubernetes/fastapi-kubernetes-runApplication.md index 5d0546114c..e67f149def 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/Kubernetes/fastapi-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/Kubernetes/fastapi-kubernetes-runApplication.md @@ -8,7 +8,13 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` - In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/fastapi/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/QuickStart/fastapi-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/QuickStart/fastapi-linuxamd64-quickStart-instrumentApplication.md index 0a00745fb3..1e067b3e7c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/QuickStart/fastapi-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/QuickStart/fastapi-linuxamd64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,24 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/QuickStart/fastapi-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/QuickStart/fastapi-linuxamd64-quickStart-runApplication.md index 63e930e26f..442a94ff8f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/QuickStart/fastapi-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/QuickStart/fastapi-linuxamd64-quickStart-runApplication.md @@ -10,5 +10,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `uvicorn main:app --host localhost --port 5002` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/fastapi/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/Recommended/fastapi-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/Recommended/fastapi-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/Recommended/fastapi-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/Recommended/fastapi-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/Recommended/fastapi-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/Recommended/fastapi-linuxamd64-recommended-instrumentApplication.md index 0a00745fb3..1e067b3e7c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/Recommended/fastapi-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/Recommended/fastapi-linuxamd64-recommended-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,24 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/Recommended/fastapi-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/Recommended/fastapi-linuxamd64-recommended-runApplication.md index 560df05d6d..5df28406c0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/Recommended/fastapi-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxAMD64/Recommended/fastapi-linuxamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -5,28 +7,36 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs + +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash -OTEL_RESOURCE_ATTRIBUTES=service.name= \ +OTEL_RESOURCE_ATTRIBUTES=service.name={{MYAPP}} \ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317" \ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/fastapi/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/QuickStart/fastapi-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/QuickStart/fastapi-linuxarm64-quickStart-instrumentApplication.md index 0a00745fb3..1e067b3e7c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/QuickStart/fastapi-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/QuickStart/fastapi-linuxarm64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,24 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/QuickStart/fastapi-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/QuickStart/fastapi-linuxarm64-quickStart-runApplication.md index ca867a458c..442a94ff8f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/QuickStart/fastapi-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/QuickStart/fastapi-linuxarm64-quickStart-runApplication.md @@ -8,7 +8,13 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc \ opentelemetry-instrument ``` -`` can be something like `python3 app.py` or `uvicorn main:app --host localhost --port 5002d` +`` can be something like `python3 app.py` or `uvicorn main:app --host localhost --port 5002` + +  **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/fastapi/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/Recommended/fastapi-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/Recommended/fastapi-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/Recommended/fastapi-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/Recommended/fastapi-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/Recommended/fastapi-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/Recommended/fastapi-linuxarm64-recommended-instrumentApplication.md index 0a00745fb3..1e067b3e7c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/Recommended/fastapi-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/Recommended/fastapi-linuxarm64-recommended-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,24 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/Recommended/fastapi-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/Recommended/fastapi-linuxarm64-recommended-runApplication.md index 560df05d6d..5df28406c0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/Recommended/fastapi-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/LinuxARM64/Recommended/fastapi-linuxarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -5,28 +7,36 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs + +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash -OTEL_RESOURCE_ATTRIBUTES=service.name= \ +OTEL_RESOURCE_ATTRIBUTES=service.name={{MYAPP}} \ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317" \ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/fastapi/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/QuickStart/fastapi-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/QuickStart/fastapi-macosamd64-quickStart-instrumentApplication.md index 0a00745fb3..1e067b3e7c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/QuickStart/fastapi-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/QuickStart/fastapi-macosamd64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,24 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/QuickStart/fastapi-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/QuickStart/fastapi-macosamd64-quickStart-runApplication.md index 63e930e26f..442a94ff8f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/QuickStart/fastapi-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/QuickStart/fastapi-macosamd64-quickStart-runApplication.md @@ -10,5 +10,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `uvicorn main:app --host localhost --port 5002` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/fastapi/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/Recommended/fastapi-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/Recommended/fastapi-macosamd64-recommended-installOtelCollector.md index ffd03775a4..843e86a411 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/Recommended/fastapi-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/Recommended/fastapi-macosamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ ### 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/Recommended/fastapi-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/Recommended/fastapi-macosamd64-recommended-instrumentApplication.md index 0a00745fb3..1e067b3e7c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/Recommended/fastapi-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/Recommended/fastapi-macosamd64-recommended-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,24 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/Recommended/fastapi-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/Recommended/fastapi-macosamd64-recommended-runApplication.md index 560df05d6d..5df28406c0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/Recommended/fastapi-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsAMD64/Recommended/fastapi-macosamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -5,28 +7,36 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs + +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash -OTEL_RESOURCE_ATTRIBUTES=service.name= \ +OTEL_RESOURCE_ATTRIBUTES=service.name={{MYAPP}} \ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317" \ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/fastapi/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/QuickStart/fastapi-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/QuickStart/fastapi-macosarm64-quickStart-instrumentApplication.md index 0a00745fb3..1e067b3e7c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/QuickStart/fastapi-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/QuickStart/fastapi-macosarm64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,24 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/QuickStart/fastapi-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/QuickStart/fastapi-macosarm64-quickStart-runApplication.md index 63e930e26f..442a94ff8f 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/QuickStart/fastapi-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/QuickStart/fastapi-macosarm64-quickStart-runApplication.md @@ -10,5 +10,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `uvicorn main:app --host localhost --port 5002` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/fastapi/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/Recommended/fastapi-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/Recommended/fastapi-macosarm64-recommended-installOtelCollector.md index ab4a153670..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/Recommended/fastapi-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/Recommended/fastapi-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/Recommended/fastapi-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/Recommended/fastapi-macosarm64-recommended-instrumentApplication.md index 0a00745fb3..1e067b3e7c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/Recommended/fastapi-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/Recommended/fastapi-macosarm64-recommended-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,24 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/Recommended/fastapi-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/Recommended/fastapi-macosarm64-recommended-runApplication.md index 560df05d6d..5df28406c0 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/Recommended/fastapi-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/FastAPI/MacOsARM64/Recommended/fastapi-macosarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -5,28 +7,36 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs + +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application ```bash -OTEL_RESOURCE_ATTRIBUTES=service.name= \ +OTEL_RESOURCE_ATTRIBUTES=service.name={{MYAPP}} \ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317" \ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `python manage.py runserver --noreload` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/fastapi/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/Kubernetes/flask-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/Kubernetes/flask-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/Kubernetes/flask-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/Kubernetes/flask-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/Kubernetes/flask-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/Kubernetes/flask-kubernetes-instrumentApplication.md index c8f0f9df39..f0420aa305 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/Kubernetes/flask-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/Kubernetes/flask-kubernetes-instrumentApplication.md @@ -1,8 +1,12 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -11,18 +15,22 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` +  **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/Kubernetes/flask-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/Kubernetes/flask-kubernetes-runApplication.md index 330c6cfb61..92293bb356 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/Kubernetes/flask-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/Kubernetes/flask-kubernetes-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using this command ```bash @@ -8,7 +10,13 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument `` can be something like `python3 app.py` or `flask run` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` - In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/flask/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/QuickStart/flask-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/QuickStart/flask-linuxamd64-quickStart-instrumentApplication.md index 0a00745fb3..d13a222df2 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/QuickStart/flask-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/QuickStart/flask-linuxamd64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,6 +11,8 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash @@ -16,11 +20,16 @@ pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  + ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/QuickStart/flask-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/QuickStart/flask-linuxamd64-quickStart-runApplication.md index 3b68b5fd16..9b1aed8b90 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/QuickStart/flask-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/QuickStart/flask-linuxamd64-quickStart-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using this command ```bash @@ -10,5 +12,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `flask run` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/flask/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/Recommended/flask-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/Recommended/flask-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/Recommended/flask-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/Recommended/flask-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/Recommended/flask-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/Recommended/flask-linuxamd64-recommended-instrumentApplication.md index 0a00745fb3..1e067b3e7c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/Recommended/flask-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/Recommended/flask-linuxamd64-recommended-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,24 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/Recommended/flask-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/Recommended/flask-linuxamd64-recommended-runApplication.md index 1b4ffafed0..626e8a6619 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/Recommended/flask-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxAMD64/Recommended/flask-linuxamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -5,15 +7,21 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs + +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` + +  + ### Step 2: Run your application ```bash @@ -23,9 +31,13 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `flask run` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/flask/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/QuickStart/flask-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/QuickStart/flask-linuxarm64-quickStart-instrumentApplication.md index 0a00745fb3..d13a222df2 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/QuickStart/flask-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/QuickStart/flask-linuxarm64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,6 +11,8 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash @@ -16,11 +20,16 @@ pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  + ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/QuickStart/flask-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/QuickStart/flask-linuxarm64-quickStart-runApplication.md index 3b68b5fd16..9b1aed8b90 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/QuickStart/flask-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/QuickStart/flask-linuxarm64-quickStart-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using this command ```bash @@ -10,5 +12,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `flask run` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/flask/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/Recommended/flask-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/Recommended/flask-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/Recommended/flask-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/Recommended/flask-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/Recommended/flask-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/Recommended/flask-linuxarm64-recommended-instrumentApplication.md index 5b65a16006..1e067b3e7c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/Recommended/flask-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/Recommended/flask-linuxarm64-recommended-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,12 +11,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation @@ -22,5 +27,8 @@ pip install opentelemetry-exporter-otlp==1.17.0 opentelemetry-bootstrap --action=install ``` +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. + diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/Recommended/flask-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/Recommended/flask-linuxarm64-recommended-runApplication.md index 1b4ffafed0..626e8a6619 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/Recommended/flask-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/LinuxARM64/Recommended/flask-linuxarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -5,15 +7,21 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs + +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` + +  + ### Step 2: Run your application ```bash @@ -23,9 +31,13 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `flask run` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/flask/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/QuickStart/flask-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/QuickStart/flask-macosamd64-quickStart-instrumentApplication.md index 0a00745fb3..d13a222df2 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/QuickStart/flask-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/QuickStart/flask-macosamd64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,6 +11,8 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash @@ -16,11 +20,16 @@ pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  + ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/QuickStart/flask-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/QuickStart/flask-macosamd64-quickStart-runApplication.md index 3b68b5fd16..9b1aed8b90 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/QuickStart/flask-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/QuickStart/flask-macosamd64-quickStart-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using this command ```bash @@ -10,5 +12,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `flask run` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/flask/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/Recommended/flask-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/Recommended/flask-macosamd64-recommended-installOtelCollector.md index ffd03775a4..843e86a411 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/Recommended/flask-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/Recommended/flask-macosamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ ### 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/Recommended/flask-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/Recommended/flask-macosamd64-recommended-instrumentApplication.md index 0a00745fb3..1e067b3e7c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/Recommended/flask-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/Recommended/flask-macosamd64-recommended-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,24 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/Recommended/flask-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/Recommended/flask-macosamd64-recommended-runApplication.md index 1b4ffafed0..626e8a6619 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/Recommended/flask-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsAMD64/Recommended/flask-macosamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -5,15 +7,21 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs + +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` + +  + ### Step 2: Run your application ```bash @@ -23,9 +31,13 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `flask run` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/flask/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/QuickStart/flask-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/QuickStart/flask-macosarm64-quickStart-instrumentApplication.md index 0a00745fb3..d13a222df2 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/QuickStart/flask-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/QuickStart/flask-macosarm64-quickStart-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,6 +11,8 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash @@ -16,11 +20,16 @@ pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  + ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/QuickStart/flask-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/QuickStart/flask-macosarm64-quickStart-runApplication.md index 3b68b5fd16..9b1aed8b90 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/QuickStart/flask-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/QuickStart/flask-macosarm64-quickStart-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using this command ```bash @@ -10,5 +12,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `flask run` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/flask/#troubleshooting-your-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/Recommended/flask-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/Recommended/flask-macosarm64-recommended-installOtelCollector.md index ab4a153670..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/Recommended/flask-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/Recommended/flask-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/Recommended/flask-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/Recommended/flask-macosarm64-recommended-instrumentApplication.md index 0a00745fb3..1e067b3e7c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/Recommended/flask-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/Recommended/flask-macosarm64-recommended-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,18 +11,24 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation ```bash opentelemetry-bootstrap --action=install ``` + +  + **Note:** - Please make sure that you have installed all the dependencies of your application before running the command in **Step 3**. The command will not install instrumentation for the dependencies which are not installed. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/Recommended/flask-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/Recommended/flask-macosarm64-recommended-runApplication.md index 1b4ffafed0..626e8a6619 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/Recommended/flask-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Flask/MacOsARM64/Recommended/flask-macosarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -5,15 +7,21 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs + +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` + +  + ### Step 2: Run your application ```bash @@ -23,9 +31,13 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `flask run` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/flask/#troubleshooting-your-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/Kubernetes/others-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/Kubernetes/others-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/Kubernetes/others-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/Kubernetes/others-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/Kubernetes/others-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/Kubernetes/others-kubernetes-instrumentApplication.md index 2a5c0c64be..6440fe8472 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/Kubernetes/others-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/Kubernetes/others-kubernetes-instrumentApplication.md @@ -1,8 +1,12 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -11,6 +15,8 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash @@ -18,6 +24,8 @@ pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  + ### Step 3 : Add automatic instrumentation ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/Kubernetes/others-kubernetes-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/Kubernetes/others-kubernetes-runApplication.md index 330c6cfb61..f15242297a 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/Kubernetes/others-kubernetes-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/Kubernetes/others-kubernetes-runApplication.md @@ -8,7 +8,13 @@ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument `` can be something like `python3 app.py` or `flask run` +  + **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` - In case you're dockerising your application, make sure to dockerise it along with OpenTelemetry instrumentation done in previous step. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/python/#troubleshooting-your-signoz-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-instrumentApplication.md index 2a5c0c64be..80bc832d58 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-instrumentApplication.md @@ -1,8 +1,12 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -11,12 +15,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-runApplication.md index 3b68b5fd16..943a083861 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/QuickStart/others-linuxamd64-quickStart-runApplication.md @@ -10,5 +10,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `flask run` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/python/#troubleshooting-your-signoz-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-instrumentApplication.md index cccc4bf6dd..66cadfe365 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-instrumentApplication.md @@ -1,6 +1,8 @@ #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -9,12 +11,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-runApplication.md index 023ec08de6..19bb0714a9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxAMD64/Recommended/others-linuxamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -5,15 +7,18 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application @@ -23,10 +28,13 @@ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317" \ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `flask run` +  **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/python/#troubleshooting-your-signoz-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-instrumentApplication.md index 2a5c0c64be..80bc832d58 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-instrumentApplication.md @@ -1,8 +1,12 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -11,12 +15,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-runApplication.md index 3b68b5fd16..943a083861 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/QuickStart/others-linuxarm64-quickStart-runApplication.md @@ -10,5 +10,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `flask run` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/python/#troubleshooting-your-signoz-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-instrumentApplication.md index 2a5c0c64be..66cadfe365 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-instrumentApplication.md @@ -1,8 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application - #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -11,12 +11,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-runApplication.md index 023ec08de6..19bb0714a9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/LinuxARM64/Recommended/others-linuxarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -5,15 +7,18 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application @@ -23,10 +28,13 @@ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317" \ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `flask run` +  **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/python/#troubleshooting-your-signoz-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-instrumentApplication.md index 43c89c5d66..80bc832d58 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-instrumentApplication.md @@ -1,9 +1,12 @@ +  -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -12,12 +15,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-runApplication.md index 3b68b5fd16..943a083861 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/QuickStart/others-macosamd64-quickStart-runApplication.md @@ -10,5 +10,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `flask run` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/python/#troubleshooting-your-signoz-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-installOtelCollector.md index ffd03775a4..843e86a411 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ ### 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-instrumentApplication.md index 2a5c0c64be..66cadfe365 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-instrumentApplication.md @@ -1,8 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application - #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -11,12 +11,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-runApplication.md index 023ec08de6..19bb0714a9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsAMD64/Recommended/others-macosamd64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -5,15 +7,18 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application @@ -23,10 +28,13 @@ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317" \ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `flask run` +  **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/python/#troubleshooting-your-signoz-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-instrumentApplication.md index 43c89c5d66..80bc832d58 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-instrumentApplication.md @@ -1,9 +1,12 @@ +  -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application +After setting up the Otel collector agent, follow the steps below to instrument your Python Application #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -12,12 +15,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-runApplication.md index 3b68b5fd16..943a083861 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/QuickStart/others-macosarm64-quickStart-runApplication.md @@ -10,5 +10,11 @@ opentelemetry-instrument `` can be something like `python3 app.py` or `flask run` +  + **Note** - Don’t run app in reloader/hot-reload mode as it breaks instrumentation. For example, you can disable the auto reload with --noreload. + +  + +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/python/#troubleshooting-your-signoz-installation) for assistance. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-installOtelCollector.md index ab4a153670..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-instrumentApplication.md index 2a5c0c64be..66cadfe365 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-instrumentApplication.md @@ -1,8 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Python Application - #### Requirements - Python 3.8 or newer +  + ### Step 1 : Create a virtual environment ```bash @@ -11,12 +11,15 @@ source .venv/bin/activate ``` This will create and activate a virtual environment named `.venv` +  + ### Step 2 : Install the OpenTelemetry dependencies ```bash pip install opentelemetry-distro==0.38b0 pip install opentelemetry-exporter-otlp==1.17.0 ``` +  ### Step 3 : Add automatic instrumentation diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-runApplication.md index 023ec08de6..19bb0714a9 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/Python/md-docs/Others/MacOsARM64/Recommended/others-macosarm64-recommended-runApplication.md @@ -1,3 +1,5 @@ +  + Once you are done intrumenting your python application, you can run it using the below steps ### Step 1: Run OTel Collector @@ -5,15 +7,18 @@ Once you are done intrumenting your python application, you can run it using the ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Run your application @@ -23,10 +28,13 @@ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4317" \ OTEL_EXPORTER_OTLP_PROTOCOL=grpc opentelemetry-instrument ``` `` can be something like `python3 app.py` or `flask run` +  **Note** - Use port **`4317`** for gRPC exporter and port **`4318`** for HTTP exporter - If your OpenTelemetry Collector agent is in different VM, replace `http://localhost:4317` in above run command with `:4317` +  +If you encounter any difficulties, please consult the [troubleshooting section](https://signoz.io/docs/instrumentation/python/#troubleshooting-your-signoz-installation) for assistance. diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/Kubernetes/ror-kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/Kubernetes/ror-kubernetes-installOtelCollector.md index e6703d8980..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/Kubernetes/ror-kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/Kubernetes/ror-kubernetes-installOtelCollector.md @@ -1,14 +1,17 @@ -### Install otel-collector in your Kubernetes infra +## 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 diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/Kubernetes/ror-kubernetes-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/Kubernetes/ror-kubernetes-instrumentApplication.md index d1999fcbc6..7622c4d4ff 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/Kubernetes/ror-kubernetes-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/Kubernetes/ror-kubernetes-instrumentApplication.md @@ -1,4 +1,6 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Ruby On Rails Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Ruby On Rails Application ### Step 1: Install dependencies Install dependencies related to OpenTelemetry SDK and exporter using gem @@ -7,6 +9,7 @@ gem install opentelemetry-sdk gem install opentelemetry-exporter-otlp gem install opentelemetry-instrumentation-all ``` +  Include the required packages into your gemfile ```bash @@ -14,11 +17,13 @@ gem 'opentelemetry-sdk' gem 'opentelemetry-exporter-otlp' gem 'opentelemetry-instrumentation-all' ``` +  Run the bundle install command: ```bash bundle install ``` +  ### Step 2: Initialize the OpenTelemetry SDK Initialize the otel sdk by adding below lines to `config/environment.rb` of your Ruby on Rails application diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/QuickStart/ror-linuxamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/QuickStart/ror-linuxamd64-quickStart-instrumentApplication.md index a6ba47e1c3..c376c08802 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/QuickStart/ror-linuxamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/QuickStart/ror-linuxamd64-quickStart-instrumentApplication.md @@ -1,4 +1,4 @@ - +  ### Step 1: Install dependencies Install dependencies related to OpenTelemetry SDK and exporter using gem @@ -7,6 +7,7 @@ gem install opentelemetry-sdk gem install opentelemetry-exporter-otlp gem install opentelemetry-instrumentation-all ``` +  Include the required packages into your gemfile ```bash @@ -14,11 +15,13 @@ gem 'opentelemetry-sdk' gem 'opentelemetry-exporter-otlp' gem 'opentelemetry-instrumentation-all' ``` +  Run the bundle install command: ```bash bundle install ``` +  ### Step 2: Initialize the OpenTelemetry SDK Initialize the otel sdk by adding below lines to `config/environment.rb` of your Ruby on Rails application diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/Recommended/ror-linuxamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/Recommended/ror-linuxamd64-recommended-installOtelCollector.md index 085baefc95..a659f36474 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/Recommended/ror-linuxamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/Recommended/ror-linuxamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/Recommended/ror-linuxamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/Recommended/ror-linuxamd64-recommended-instrumentApplication.md index d1999fcbc6..e257eeac88 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/Recommended/ror-linuxamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/Recommended/ror-linuxamd64-recommended-instrumentApplication.md @@ -1,4 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Ruby On Rails Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Ruby On Rails Application + +  ### Step 1: Install dependencies Install dependencies related to OpenTelemetry SDK and exporter using gem @@ -7,6 +11,7 @@ gem install opentelemetry-sdk gem install opentelemetry-exporter-otlp gem install opentelemetry-instrumentation-all ``` +  Include the required packages into your gemfile ```bash @@ -14,11 +19,13 @@ gem 'opentelemetry-sdk' gem 'opentelemetry-exporter-otlp' gem 'opentelemetry-instrumentation-all' ``` +  Run the bundle install command: ```bash bundle install ``` +  ### Step 2: Initialize the OpenTelemetry SDK Initialize the otel sdk by adding below lines to `config/environment.rb` of your Ruby on Rails application diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/Recommended/ror-linuxamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/Recommended/ror-linuxamd64-recommended-runApplication.md index fce73c7c3a..4cff1ef446 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/Recommended/ror-linuxamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxAMD64/Recommended/ror-linuxamd64-recommended-runApplication.md @@ -1,20 +1,27 @@ +  + Once you are done intrumenting your Ruby on Rails 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 &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Running your Ruby application @@ -26,6 +33,7 @@ OTEL_SERVICE_NAME={{MYAPP}} \ OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318 \ rails server ``` +  **Note:** - In case you have OtelCollector Agent in different VM, replace localhost:4318 with :4318. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/QuickStart/ror-linuxarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/QuickStart/ror-linuxarm64-quickStart-instrumentApplication.md index 8238d4b499..c376c08802 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/QuickStart/ror-linuxarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/QuickStart/ror-linuxarm64-quickStart-instrumentApplication.md @@ -1,3 +1,4 @@ +  ### Step 1: Install dependencies Install dependencies related to OpenTelemetry SDK and exporter using gem @@ -6,6 +7,7 @@ gem install opentelemetry-sdk gem install opentelemetry-exporter-otlp gem install opentelemetry-instrumentation-all ``` +  Include the required packages into your gemfile ```bash @@ -13,11 +15,13 @@ gem 'opentelemetry-sdk' gem 'opentelemetry-exporter-otlp' gem 'opentelemetry-instrumentation-all' ``` +  Run the bundle install command: ```bash bundle install ``` +  ### Step 2: Initialize the OpenTelemetry SDK Initialize the otel sdk by adding below lines to `config/environment.rb` of your Ruby on Rails application diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/Recommended/ror-linuxarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/Recommended/ror-linuxarm64-recommended-installOtelCollector.md index 9c793c7742..cbabb8077b 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/Recommended/ror-linuxarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/Recommended/ror-linuxarm64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_arm64.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_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/Recommended/ror-linuxarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/Recommended/ror-linuxarm64-recommended-instrumentApplication.md index d1999fcbc6..e257eeac88 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/Recommended/ror-linuxarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/Recommended/ror-linuxarm64-recommended-instrumentApplication.md @@ -1,4 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Ruby On Rails Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Ruby On Rails Application + +  ### Step 1: Install dependencies Install dependencies related to OpenTelemetry SDK and exporter using gem @@ -7,6 +11,7 @@ gem install opentelemetry-sdk gem install opentelemetry-exporter-otlp gem install opentelemetry-instrumentation-all ``` +  Include the required packages into your gemfile ```bash @@ -14,11 +19,13 @@ gem 'opentelemetry-sdk' gem 'opentelemetry-exporter-otlp' gem 'opentelemetry-instrumentation-all' ``` +  Run the bundle install command: ```bash bundle install ``` +  ### Step 2: Initialize the OpenTelemetry SDK Initialize the otel sdk by adding below lines to `config/environment.rb` of your Ruby on Rails application diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/Recommended/ror-linuxarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/Recommended/ror-linuxarm64-recommended-runApplication.md index fce73c7c3a..4cff1ef446 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/Recommended/ror-linuxarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/LinuxARM64/Recommended/ror-linuxarm64-recommended-runApplication.md @@ -1,20 +1,27 @@ +  + Once you are done intrumenting your Ruby on Rails 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 &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Running your Ruby application @@ -26,6 +33,7 @@ OTEL_SERVICE_NAME={{MYAPP}} \ OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318 \ rails server ``` +  **Note:** - In case you have OtelCollector Agent in different VM, replace localhost:4318 with :4318. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/QuickStart/ror-macosamd64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/QuickStart/ror-macosamd64-quickStart-instrumentApplication.md index 8238d4b499..c376c08802 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/QuickStart/ror-macosamd64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/QuickStart/ror-macosamd64-quickStart-instrumentApplication.md @@ -1,3 +1,4 @@ +  ### Step 1: Install dependencies Install dependencies related to OpenTelemetry SDK and exporter using gem @@ -6,6 +7,7 @@ gem install opentelemetry-sdk gem install opentelemetry-exporter-otlp gem install opentelemetry-instrumentation-all ``` +  Include the required packages into your gemfile ```bash @@ -13,11 +15,13 @@ gem 'opentelemetry-sdk' gem 'opentelemetry-exporter-otlp' gem 'opentelemetry-instrumentation-all' ``` +  Run the bundle install command: ```bash bundle install ``` +  ### Step 2: Initialize the OpenTelemetry SDK Initialize the otel sdk by adding below lines to `config/environment.rb` of your Ruby on Rails application diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/Recommended/ror-macosamd64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/Recommended/ror-macosamd64-recommended-installOtelCollector.md index ffd03775a4..843e86a411 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/Recommended/ror-macosamd64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/Recommended/ror-macosamd64-recommended-installOtelCollector.md @@ -1,14 +1,17 @@ ### 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_darwin_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_darwin_amd64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/Recommended/ror-macosamd64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/Recommended/ror-macosamd64-recommended-instrumentApplication.md index d1999fcbc6..e257eeac88 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/Recommended/ror-macosamd64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/Recommended/ror-macosamd64-recommended-instrumentApplication.md @@ -1,4 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Ruby On Rails Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Ruby On Rails Application + +  ### Step 1: Install dependencies Install dependencies related to OpenTelemetry SDK and exporter using gem @@ -7,6 +11,7 @@ gem install opentelemetry-sdk gem install opentelemetry-exporter-otlp gem install opentelemetry-instrumentation-all ``` +  Include the required packages into your gemfile ```bash @@ -14,11 +19,13 @@ gem 'opentelemetry-sdk' gem 'opentelemetry-exporter-otlp' gem 'opentelemetry-instrumentation-all' ``` +  Run the bundle install command: ```bash bundle install ``` +  ### Step 2: Initialize the OpenTelemetry SDK Initialize the otel sdk by adding below lines to `config/environment.rb` of your Ruby on Rails application diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/Recommended/ror-macosamd64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/Recommended/ror-macosamd64-recommended-runApplication.md index fce73c7c3a..4cff1ef446 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/Recommended/ror-macosamd64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsAMD64/Recommended/ror-macosamd64-recommended-runApplication.md @@ -1,20 +1,27 @@ +  + Once you are done intrumenting your Ruby on Rails 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 &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Running your Ruby application @@ -26,6 +33,7 @@ OTEL_SERVICE_NAME={{MYAPP}} \ OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318 \ rails server ``` +  **Note:** - In case you have OtelCollector Agent in different VM, replace localhost:4318 with :4318. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/QuickStart/ror-macosarm64-quickStart-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/QuickStart/ror-macosarm64-quickStart-instrumentApplication.md index 8238d4b499..c376c08802 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/QuickStart/ror-macosarm64-quickStart-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/QuickStart/ror-macosarm64-quickStart-instrumentApplication.md @@ -1,3 +1,4 @@ +  ### Step 1: Install dependencies Install dependencies related to OpenTelemetry SDK and exporter using gem @@ -6,6 +7,7 @@ gem install opentelemetry-sdk gem install opentelemetry-exporter-otlp gem install opentelemetry-instrumentation-all ``` +  Include the required packages into your gemfile ```bash @@ -13,11 +15,13 @@ gem 'opentelemetry-sdk' gem 'opentelemetry-exporter-otlp' gem 'opentelemetry-instrumentation-all' ``` +  Run the bundle install command: ```bash bundle install ``` +  ### Step 2: Initialize the OpenTelemetry SDK Initialize the otel sdk by adding below lines to `config/environment.rb` of your Ruby on Rails application diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/Recommended/ror-macosarm64-recommended-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/Recommended/ror-macosarm64-recommended-installOtelCollector.md index ab4a153670..3a780bb8de 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/Recommended/ror-macosarm64-recommended-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/Recommended/ror-macosarm64-recommended-installOtelCollector.md @@ -1,13 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  ### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/Recommended/ror-macosarm64-recommended-instrumentApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/Recommended/ror-macosarm64-recommended-instrumentApplication.md index d1999fcbc6..e257eeac88 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/Recommended/ror-macosarm64-recommended-instrumentApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/Recommended/ror-macosarm64-recommended-instrumentApplication.md @@ -1,4 +1,8 @@ -After setting up the Otel collector agent, follow the steps below to instrumnet your Ruby On Rails Application +  + +After setting up the Otel collector agent, follow the steps below to instrument your Ruby On Rails Application + +  ### Step 1: Install dependencies Install dependencies related to OpenTelemetry SDK and exporter using gem @@ -7,6 +11,7 @@ gem install opentelemetry-sdk gem install opentelemetry-exporter-otlp gem install opentelemetry-instrumentation-all ``` +  Include the required packages into your gemfile ```bash @@ -14,11 +19,13 @@ gem 'opentelemetry-sdk' gem 'opentelemetry-exporter-otlp' gem 'opentelemetry-instrumentation-all' ``` +  Run the bundle install command: ```bash bundle install ``` +  ### Step 2: Initialize the OpenTelemetry SDK Initialize the otel sdk by adding below lines to `config/environment.rb` of your Ruby on Rails application diff --git a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/Recommended/ror-macosarm64-recommended-runApplication.md b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/Recommended/ror-macosarm64-recommended-runApplication.md index fce73c7c3a..4cff1ef446 100644 --- a/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/Recommended/ror-macosarm64-recommended-runApplication.md +++ b/frontend/src/container/OnboardingContainer/Modules/APM/RubyOnRails/md-docs/MacOsARM64/Recommended/ror-macosarm64-recommended-runApplication.md @@ -1,20 +1,27 @@ +  + Once you are done intrumenting your Ruby on Rails 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 &> otelcol-output.log & echo "$!" > otel-pid ``` -### (Optional Step): View last 50 lines of `otelcol` logs +  + +#### (Optional Step): View last 50 lines of `otelcol` logs ```bash tail -f -n 50 otelcol-output.log ``` -### (Optional Step): Stop `otelcol` +#### (Optional Step): Stop `otelcol` ```bash kill "$(< otel-pid)" ``` +  ### Step 2: Running your Ruby application @@ -26,6 +33,7 @@ OTEL_SERVICE_NAME={{MYAPP}} \ OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318 \ rails server ``` +  **Note:** - In case you have OtelCollector Agent in different VM, replace localhost:4318 with :4318. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/KubernetesInfraMetrics/md-docs/kubernetes-setupOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/KubernetesInfraMetrics/md-docs/kubernetes-setupOtelCollector.md index ce88d018a6..e6703d8980 100644 --- a/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/KubernetesInfraMetrics/md-docs/kubernetes-setupOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/KubernetesInfraMetrics/md-docs/kubernetes-setupOtelCollector.md @@ -1,4 +1,4 @@ -### Install otel-collectors in your Kubernetes infra +### Install otel-collector in your Kubernetes infra Add the SigNoz Helm Chart repository ```bash @@ -13,8 +13,9 @@ 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 otelCollectorEndpoint=ingest.{{REGION}}.signoz.cloud:443 \ --set otelInsecure=false \ ---set signozApiKey= \ +--set signozApiKey={{SIGNOZ_INGESTION_KEY}} \ --set global.clusterName= ``` +- Replace `` with the name of the Kubernetes cluster or a unique identifier of the cluster. diff --git a/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/LinuxAMD64/otherMetrics-configureReceiver.md b/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/LinuxAMD64/otherMetrics-configureReceiver.md index 6a113faed2..1074c76393 100644 --- a/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/LinuxAMD64/otherMetrics-configureReceiver.md +++ b/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/LinuxAMD64/otherMetrics-configureReceiver.md @@ -68,7 +68,7 @@ service: ``` For details about configuring OpenTelemetry receivers, see the [README](https://github.com/open-telemetry/opentelemetry-collector/blob/main/receiver/README.md) page of the opentelemetry-collector GitHub repository. -# Enable a specific metrics Receiver +# Enable Prometheus Receiver SigNoz supports all the exporters that are listed on the [Exporters and Integrations](https://prometheus.io/docs/instrumenting/exporters/) page of the Prometheus documentation. If you have a running Prometheus instance, and you expose metrics in Prometheus, then you can scrape them in SigNoz by configuring Prometheus receivers in the **`receivers::prometheus::config::scrape_configs`** section of the **`config.yaml`** file you created in the previous step. diff --git a/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/LinuxARM64/otherMetrics-configureReceiver.md b/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/LinuxARM64/otherMetrics-configureReceiver.md index 6a113faed2..1074c76393 100644 --- a/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/LinuxARM64/otherMetrics-configureReceiver.md +++ b/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/LinuxARM64/otherMetrics-configureReceiver.md @@ -68,7 +68,7 @@ service: ``` For details about configuring OpenTelemetry receivers, see the [README](https://github.com/open-telemetry/opentelemetry-collector/blob/main/receiver/README.md) page of the opentelemetry-collector GitHub repository. -# Enable a specific metrics Receiver +# Enable Prometheus Receiver SigNoz supports all the exporters that are listed on the [Exporters and Integrations](https://prometheus.io/docs/instrumenting/exporters/) page of the Prometheus documentation. If you have a running Prometheus instance, and you expose metrics in Prometheus, then you can scrape them in SigNoz by configuring Prometheus receivers in the **`receivers::prometheus::config::scrape_configs`** section of the **`config.yaml`** file you created in the previous step. diff --git a/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/MacOsAMD64/otherMetrics-configureReceiver.md b/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/MacOsAMD64/otherMetrics-configureReceiver.md index 6a113faed2..1074c76393 100644 --- a/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/MacOsAMD64/otherMetrics-configureReceiver.md +++ b/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/MacOsAMD64/otherMetrics-configureReceiver.md @@ -68,7 +68,7 @@ service: ``` For details about configuring OpenTelemetry receivers, see the [README](https://github.com/open-telemetry/opentelemetry-collector/blob/main/receiver/README.md) page of the opentelemetry-collector GitHub repository. -# Enable a specific metrics Receiver +# Enable Prometheus Receiver SigNoz supports all the exporters that are listed on the [Exporters and Integrations](https://prometheus.io/docs/instrumenting/exporters/) page of the Prometheus documentation. If you have a running Prometheus instance, and you expose metrics in Prometheus, then you can scrape them in SigNoz by configuring Prometheus receivers in the **`receivers::prometheus::config::scrape_configs`** section of the **`config.yaml`** file you created in the previous step. diff --git a/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/MacOsARM64/otherMetrics-configureReceiver.md b/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/MacOsARM64/otherMetrics-configureReceiver.md index 6a113faed2..1074c76393 100644 --- a/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/MacOsARM64/otherMetrics-configureReceiver.md +++ b/frontend/src/container/OnboardingContainer/Modules/InfrastructureMonitoring/OtherMetrics/md-docs/MacOsARM64/otherMetrics-configureReceiver.md @@ -68,7 +68,7 @@ service: ``` For details about configuring OpenTelemetry receivers, see the [README](https://github.com/open-telemetry/opentelemetry-collector/blob/main/receiver/README.md) page of the opentelemetry-collector GitHub repository. -# Enable a specific metrics Receiver +# Enable Prometheus Receiver SigNoz supports all the exporters that are listed on the [Exporters and Integrations](https://prometheus.io/docs/instrumenting/exporters/) page of the Prometheus documentation. If you have a running Prometheus instance, and you expose metrics in Prometheus, then you can scrape them in SigNoz by configuring Prometheus receivers in the **`receivers::prometheus::config::scrape_configs`** section of the **`config.yaml`** file you created in the previous step. diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/MacOsARM64/appplicationLogs-macosarm64-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/MacOsARM64/appplicationLogs-macosarm64-installOtelCollector.md index 6710446650..85a19c7c9c 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/MacOsARM64/appplicationLogs-macosarm64-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/MacOsARM64/appplicationLogs-macosarm64-installOtelCollector.md @@ -3,6 +3,7 @@ ### 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_darwin_arm64.tar.gz +``` ### Step 2: Extract otel-collector tar.gz to the `otelcol-contrib` folder ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Docker/md-docs/docker-cloneRepository.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Docker/md-docs/docker-cloneRepository.md index b93955c4dd..db78f20343 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Docker/md-docs/docker-cloneRepository.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Docker/md-docs/docker-cloneRepository.md @@ -6,8 +6,13 @@ Clone this GitHub repository as a first step to collect logs git clone https://github.com/SigNoz/docker-container-logs.git ``` -### Step 2: Update your `.env` file -In the repository that you cloned above, update `.env` file by putting the values of and {region}. +  -Here is your : {{SIGNOZ_INGESTION_KEY}} -Here is your {region} : {{REGION}} +### Step 2: Update your `.env` file +In the repository that you cloned above, update `.env` file by updating it with values **`SIGNOZ_INGESTION_KEY`** and **`OTEL_COLLECOTR_ENDPOINT`** shown below + +```bash +OTEL_COLLECOTR_ENDPOINT=ingest.{{REGION}}.signoz.cloud:443 +SIGNOZ_INGESTION_KEY={{SIGNOZ_INGESTION_KEY}} +``` +Paste these values in the **`.env`** file. \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Docker/md-docs/docker-startContainers.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Docker/md-docs/docker-startContainers.md index e14b2ccd1e..0c180adc78 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Docker/md-docs/docker-startContainers.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Docker/md-docs/docker-startContainers.md @@ -1,4 +1,4 @@ -### Start the docker conteiners +### Start the docker containers ```bash docker compose up -d diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/FluentBit/md-docs/MacOsARM64/fluentbit-macosarm64-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/FluentBit/md-docs/MacOsARM64/fluentbit-macosarm64-installOtelCollector.md index 6710446650..ef4ed90193 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/FluentBit/md-docs/MacOsARM64/fluentbit-macosarm64-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/FluentBit/md-docs/MacOsARM64/fluentbit-macosarm64-installOtelCollector.md @@ -3,7 +3,7 @@ ### 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/FluentD/md-docs/MacOsARM64/fluentd-macosarm64-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/FluentD/md-docs/MacOsARM64/fluentd-macosarm64-installOtelCollector.md index 6710446650..ef4ed90193 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/FluentD/md-docs/MacOsARM64/fluentd-macosarm64-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/FluentD/md-docs/MacOsARM64/fluentd-macosarm64-installOtelCollector.md @@ -3,7 +3,7 @@ ### 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Kubernetes/md-docs/kubernetes-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Kubernetes/md-docs/kubernetes-installOtelCollector.md index ce88d018a6..946b7fbdbf 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Kubernetes/md-docs/kubernetes-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Kubernetes/md-docs/kubernetes-installOtelCollector.md @@ -1,20 +1,24 @@ -### Install otel-collectors in your Kubernetes infra +## 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 otelCollectorEndpoint=ingest.{{REGION}}.signoz.cloud:443 \ --set otelInsecure=false \ ---set signozApiKey= \ +--set signozApiKey={{SIGNOZ_INGESTION_KEY}} \ --set global.clusterName= ``` +- Replace `` with the name of the Kubernetes cluster or a unique identifier of the cluster. diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxAMD64/logstash-linuxamd64-configureReceiver.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxAMD64/logstash-linuxamd64-configureReceiver.md index 7bd7640789..6c3723d4f3 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxAMD64/logstash-linuxamd64-configureReceiver.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxAMD64/logstash-linuxamd64-configureReceiver.md @@ -1,6 +1,6 @@ -### Step 1: Add fluentforward receiver +### Step 1: Add logstash receiver -Add the logstash receiver in the receivers section of `config.yaml` file of the **`otecol-contrib`** directory that you created in the previous step +Add the logstash receiver in the receivers section of `config.yaml` file of the **`otecol-contrib`** directory that you created in the previous step. ```bash receivers: @@ -15,6 +15,8 @@ receivers: Here we have used port 2255 for listening in TCP protocol, but you can change it to a port you want. You can read more about tcplog reciver [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/tcplogreceiver). +  + Modify your config.yaml and add the above receiver ```bash service: @@ -24,6 +26,7 @@ service: processors: [batch] exporters: [otlp] ``` +  ### Step 2: Update the logstash config file Add the following to your **logstash config** to forward the logs to otel collector. @@ -36,8 +39,7 @@ output { } } ``` - Replace  with your directive name. - Also we are assuming that you are running the fluentD binary on the host. If not, the value of host might change depending on your environment. +We are assuming that you are running the logstash binary on the host. If not, the value of host might change depending on your environment. - For MacOS - host is `host.docker.internal` - For other systems - host is IP address of your system \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxAMD64/logstash-linuxamd64-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxAMD64/logstash-linuxamd64-installOtelCollector.md index b390df7f0d..5f09288faa 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxAMD64/logstash-linuxamd64-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxAMD64/logstash-linuxamd64-installOtelCollector.md @@ -1,16 +1,19 @@ -### Setup OpenTelemetry Binary as an agent +## 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 folder otelcol-contrib with the below content in it +### Step 3: Create `config.yaml` in `otelcol-contrib` folder with the below content in it ```bash receivers: otlp: @@ -89,12 +92,15 @@ service: processors: [batch] exporters: [otlp] ``` +  + ### Step 4: Run OTel Collector Run this command inside the `otelcol-contrib` directory ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` +  ### (Optional Step): View last 50 lines of `otelcol` logs ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxAMD64/logstash-linuxamd64-restartOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxAMD64/logstash-linuxamd64-restartOtelCollector.md index a9a46b07ae..fa6ba92577 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxAMD64/logstash-linuxamd64-restartOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxAMD64/logstash-linuxamd64-restartOtelCollector.md @@ -1,17 +1,20 @@ ### Restart the Otel Collector Restart the otel collector so that new changes are saved and you should see the logs in the dashboard. +   -Kill the process if it was already running using the below command +**Stop OTel Collector if it was already running using the below command in `otelcol-contrib` directory** ```bash kill "$(< otel-pid)" ``` -Restart the OTel collector when you’re in the `otel-contrib` folder +**Restart the OTel collector by running the below command in `otelcol-contrib` directory** ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` +  -Restart logstash +### Restart logstash +   Now you should be able to see the Logs on your SigNoz Cloud UI diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxARM64/logstash-linuxarm64-configureReceiver.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxARM64/logstash-linuxarm64-configureReceiver.md index 7bd7640789..6c3723d4f3 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxARM64/logstash-linuxarm64-configureReceiver.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxARM64/logstash-linuxarm64-configureReceiver.md @@ -1,6 +1,6 @@ -### Step 1: Add fluentforward receiver +### Step 1: Add logstash receiver -Add the logstash receiver in the receivers section of `config.yaml` file of the **`otecol-contrib`** directory that you created in the previous step +Add the logstash receiver in the receivers section of `config.yaml` file of the **`otecol-contrib`** directory that you created in the previous step. ```bash receivers: @@ -15,6 +15,8 @@ receivers: Here we have used port 2255 for listening in TCP protocol, but you can change it to a port you want. You can read more about tcplog reciver [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/tcplogreceiver). +  + Modify your config.yaml and add the above receiver ```bash service: @@ -24,6 +26,7 @@ service: processors: [batch] exporters: [otlp] ``` +  ### Step 2: Update the logstash config file Add the following to your **logstash config** to forward the logs to otel collector. @@ -36,8 +39,7 @@ output { } } ``` - Replace  with your directive name. - Also we are assuming that you are running the fluentD binary on the host. If not, the value of host might change depending on your environment. +We are assuming that you are running the logstash binary on the host. If not, the value of host might change depending on your environment. - For MacOS - host is `host.docker.internal` - For other systems - host is IP address of your system \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxARM64/logstash-linuxarm64-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxARM64/logstash-linuxarm64-installOtelCollector.md index dda1f06777..a81fb1b713 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxARM64/logstash-linuxarm64-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxARM64/logstash-linuxarm64-installOtelCollector.md @@ -1,4 +1,5 @@ -### Setup OpenTelemetry Binary as an agent +## Setup OpenTelemetry Binary as an agent +  ### Step 1: Download otel-collector tar.gz ```bash @@ -9,8 +10,9 @@ wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases ```bash mkdir otelcol-contrib && tar xvzf otelcol-contrib_0.79.0_linux_arm64.tar.gz -C otelcol-contrib ``` +  -### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it +### Step 3: Create `config.yaml` in folder `otelcol-contrib` with the below content in it ```bash receivers: otlp: @@ -89,6 +91,7 @@ service: processors: [batch] exporters: [otlp] ``` +  ### Step 4: Run OTel Collector Run this command inside the `otelcol-contrib` directory @@ -96,6 +99,7 @@ service: ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` +  ### (Optional Step): View last 50 lines of `otelcol` logs ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxARM64/logstash-linuxarm64-restartOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxARM64/logstash-linuxarm64-restartOtelCollector.md index a9a46b07ae..fa6ba92577 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxARM64/logstash-linuxarm64-restartOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/LinuxARM64/logstash-linuxarm64-restartOtelCollector.md @@ -1,17 +1,20 @@ ### Restart the Otel Collector Restart the otel collector so that new changes are saved and you should see the logs in the dashboard. +   -Kill the process if it was already running using the below command +**Stop OTel Collector if it was already running using the below command in `otelcol-contrib` directory** ```bash kill "$(< otel-pid)" ``` -Restart the OTel collector when you’re in the `otel-contrib` folder +**Restart the OTel collector by running the below command in `otelcol-contrib` directory** ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` +  -Restart logstash +### Restart logstash +   Now you should be able to see the Logs on your SigNoz Cloud UI diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsAMD64/logstash-macosamd64-configureReceiver.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsAMD64/logstash-macosamd64-configureReceiver.md index 7bd7640789..6c3723d4f3 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsAMD64/logstash-macosamd64-configureReceiver.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsAMD64/logstash-macosamd64-configureReceiver.md @@ -1,6 +1,6 @@ -### Step 1: Add fluentforward receiver +### Step 1: Add logstash receiver -Add the logstash receiver in the receivers section of `config.yaml` file of the **`otecol-contrib`** directory that you created in the previous step +Add the logstash receiver in the receivers section of `config.yaml` file of the **`otecol-contrib`** directory that you created in the previous step. ```bash receivers: @@ -15,6 +15,8 @@ receivers: Here we have used port 2255 for listening in TCP protocol, but you can change it to a port you want. You can read more about tcplog reciver [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/tcplogreceiver). +  + Modify your config.yaml and add the above receiver ```bash service: @@ -24,6 +26,7 @@ service: processors: [batch] exporters: [otlp] ``` +  ### Step 2: Update the logstash config file Add the following to your **logstash config** to forward the logs to otel collector. @@ -36,8 +39,7 @@ output { } } ``` - Replace  with your directive name. - Also we are assuming that you are running the fluentD binary on the host. If not, the value of host might change depending on your environment. +We are assuming that you are running the logstash binary on the host. If not, the value of host might change depending on your environment. - For MacOS - host is `host.docker.internal` - For other systems - host is IP address of your system \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsAMD64/logstash-macosamd64-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsAMD64/logstash-macosamd64-installOtelCollector.md index d85ed9c4f2..ed97017f58 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsAMD64/logstash-macosamd64-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsAMD64/logstash-macosamd64-installOtelCollector.md @@ -1,4 +1,5 @@ -### Setup OpenTelemetry Binary as an agent +## Setup OpenTelemetry Binary as an agent +  ### Step 1: Download otel-collector tar.gz ```bash @@ -9,8 +10,9 @@ wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases ```bash mkdir otelcol-contrib && tar xvzf otelcol-contrib_0.79.0_darwin_amd64.tar.gz -C otelcol-contrib ``` +  -### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it +### Step 3: Create `config.yaml` in folder `otelcol-contrib` with the below content in it ```bash receivers: otlp: @@ -89,12 +91,15 @@ service: processors: [batch] exporters: [otlp] ``` +  + ### Step 4: Run OTel Collector Run this command inside the `otelcol-contrib` directory ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` +  ### (Optional Step): View last 50 lines of `otelcol` logs ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsAMD64/logstash-macosamd64-restartOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsAMD64/logstash-macosamd64-restartOtelCollector.md index a9a46b07ae..fa6ba92577 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsAMD64/logstash-macosamd64-restartOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsAMD64/logstash-macosamd64-restartOtelCollector.md @@ -1,17 +1,20 @@ ### Restart the Otel Collector Restart the otel collector so that new changes are saved and you should see the logs in the dashboard. +   -Kill the process if it was already running using the below command +**Stop OTel Collector if it was already running using the below command in `otelcol-contrib` directory** ```bash kill "$(< otel-pid)" ``` -Restart the OTel collector when you’re in the `otel-contrib` folder +**Restart the OTel collector by running the below command in `otelcol-contrib` directory** ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` +  -Restart logstash +### Restart logstash +   Now you should be able to see the Logs on your SigNoz Cloud UI diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsARM64/logstash-macosarm64-configureReceiver.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsARM64/logstash-macosarm64-configureReceiver.md index 7bd7640789..6c3723d4f3 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsARM64/logstash-macosarm64-configureReceiver.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsARM64/logstash-macosarm64-configureReceiver.md @@ -1,6 +1,6 @@ -### Step 1: Add fluentforward receiver +### Step 1: Add logstash receiver -Add the logstash receiver in the receivers section of `config.yaml` file of the **`otecol-contrib`** directory that you created in the previous step +Add the logstash receiver in the receivers section of `config.yaml` file of the **`otecol-contrib`** directory that you created in the previous step. ```bash receivers: @@ -15,6 +15,8 @@ receivers: Here we have used port 2255 for listening in TCP protocol, but you can change it to a port you want. You can read more about tcplog reciver [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/tcplogreceiver). +  + Modify your config.yaml and add the above receiver ```bash service: @@ -24,6 +26,7 @@ service: processors: [batch] exporters: [otlp] ``` +  ### Step 2: Update the logstash config file Add the following to your **logstash config** to forward the logs to otel collector. @@ -36,8 +39,7 @@ output { } } ``` - Replace  with your directive name. - Also we are assuming that you are running the fluentD binary on the host. If not, the value of host might change depending on your environment. +We are assuming that you are running the logstash binary on the host. If not, the value of host might change depending on your environment. - For MacOS - host is `host.docker.internal` - For other systems - host is IP address of your system \ No newline at end of file diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsARM64/logstash-macosarm64-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsARM64/logstash-macosarm64-installOtelCollector.md index 6710446650..4c1af5e567 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsARM64/logstash-macosarm64-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsARM64/logstash-macosarm64-installOtelCollector.md @@ -1,15 +1,17 @@ -### Setup OpenTelemetry Binary as an agent +## 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib ``` +  -### Step 3: Create config.yaml in folder otelcol-contrib with the below content in it +### Step 3: Create `config.yaml` in folder `otelcol-contrib` with the below content in it ```bash receivers: otlp: @@ -88,12 +90,15 @@ service: processors: [batch] exporters: [otlp] ``` +  + ### Step 4: Run OTel Collector Run this command inside the `otelcol-contrib` directory ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` +  ### (Optional Step): View last 50 lines of `otelcol` logs ```bash diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsARM64/logstash-macosarm64-restartOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsARM64/logstash-macosarm64-restartOtelCollector.md index a9a46b07ae..fa6ba92577 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsARM64/logstash-macosarm64-restartOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/Logstash/md-docs/MacOsARM64/logstash-macosarm64-restartOtelCollector.md @@ -1,17 +1,20 @@ ### Restart the Otel Collector Restart the otel collector so that new changes are saved and you should see the logs in the dashboard. +   -Kill the process if it was already running using the below command +**Stop OTel Collector if it was already running using the below command in `otelcol-contrib` directory** ```bash kill "$(< otel-pid)" ``` -Restart the OTel collector when you’re in the `otel-contrib` folder +**Restart the OTel collector by running the below command in `otelcol-contrib` directory** ```bash ./otelcol-contrib --config ./config.yaml &> otelcol-output.log & echo "$!" > otel-pid ``` +  -Restart logstash +### Restart logstash +   Now you should be able to see the Logs on your SigNoz Cloud UI diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/SysLogs/md-docs/MacOsARM64/syslogs-macosarm64-installOtelCollector.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/SysLogs/md-docs/MacOsARM64/syslogs-macosarm64-installOtelCollector.md index 6710446650..ef4ed90193 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/SysLogs/md-docs/MacOsARM64/syslogs-macosarm64-installOtelCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/SysLogs/md-docs/MacOsARM64/syslogs-macosarm64-installOtelCollector.md @@ -3,7 +3,7 @@ ### 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_darwin_arm64.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_darwin_arm64.tar.gz -C otelcol-contrib From 31b07cc02c24623ef52bf0ba4e2e4880f83ab17c Mon Sep 17 00:00:00 2001 From: Rajat Dabade Date: Wed, 22 Nov 2023 13:43:29 +0530 Subject: [PATCH 2/7] refactor: aggregrate api uses global time (#3911) --- frontend/src/store/actions/trace/getSpans.ts | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/frontend/src/store/actions/trace/getSpans.ts b/frontend/src/store/actions/trace/getSpans.ts index 4b2787e7a9..40d49d5959 100644 --- a/frontend/src/store/actions/trace/getSpans.ts +++ b/frontend/src/store/actions/trace/getSpans.ts @@ -28,23 +28,10 @@ export const GetSpans = ( return; } - const { selectedTime } = globalTime; - if (traces.filterLoading) { return; } - // @TODO refactor this logic when share url functionlity is updated - const isCustomSelected = selectedTime === 'custom'; - - const end = isCustomSelected - ? globalTime.maxTime + 15 * 60 * 1000000000 - : props.end; - - const start = isCustomSelected - ? globalTime.minTime - 15 * 60 * 1000000000 - : props.start; - if (!spansGraph.loading) { dispatch({ type: UPDATE_TRACE_GRAPH_LOADING, @@ -55,12 +42,12 @@ export const GetSpans = ( } const response = await getSpans({ - end, + end: props.end, function: props.function, groupBy: props.groupBy, selectedFilter: props.selectedFilter, selectedTags: props.selectedTags, - start, + start: props.start, step: props.step, isFilterExclude: props.isFilterExclude, spanKind: props.spanKind, From b1e4ee1d266bd8e76b5d8277084eb9bbd995452a Mon Sep 17 00:00:00 2001 From: Raj Kamal Singh <1133322+raj-k-singh@users.noreply.github.com> Date: Wed, 22 Nov 2023 15:54:12 +0530 Subject: [PATCH 3/7] fix: update condition for showing empty state vs showing pipeline list (#4017) --- .../PipelinePage/PipelineListsView/PipelineListsView.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frontend/src/container/PipelinePage/PipelineListsView/PipelineListsView.tsx b/frontend/src/container/PipelinePage/PipelineListsView/PipelineListsView.tsx index f574f90956..058c16761b 100644 --- a/frontend/src/container/PipelinePage/PipelineListsView/PipelineListsView.tsx +++ b/frontend/src/container/PipelinePage/PipelineListsView/PipelineListsView.tsx @@ -485,7 +485,7 @@ function PipelineListsView({ expandedPipelineData={expandedPipelineData()} setExpandedPipelineData={setExpandedPipelineData} /> - {prevPipelineData?.length > 0 ? ( + {prevPipelineData?.length > 0 || currPipelineData?.length > 0 ? ( <> From a578f9509ad39ff64657c72ca1c7c465dea481ea Mon Sep 17 00:00:00 2001 From: Srikanth Chekuri Date: Wed, 22 Nov 2023 18:41:56 +0530 Subject: [PATCH 4/7] fix: use correct operator for db and external APM metrics (#4026) --- .github/CODEOWNERS | 1 + .../MetricsPageQueries/DBCallQueries.ts | 4 ++-- .../MetricsPageQueries/ExternalQueries.ts | 12 ++++++------ 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index e851767f8f..b5d79b6351 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -4,6 +4,7 @@ * @ankitnayan /frontend/ @palashgdev @YounixM +/frontend/src/container/MetricsApplication @srikanthccv /deploy/ @prashant-shahi /sample-apps/ @prashant-shahi **/query-service/ @srikanthccv diff --git a/frontend/src/container/MetricsApplication/MetricsPageQueries/DBCallQueries.ts b/frontend/src/container/MetricsApplication/MetricsPageQueries/DBCallQueries.ts index 78d66bcaa5..2cec9e823b 100644 --- a/frontend/src/container/MetricsApplication/MetricsPageQueries/DBCallQueries.ts +++ b/frontend/src/container/MetricsApplication/MetricsPageQueries/DBCallQueries.ts @@ -114,8 +114,8 @@ export const databaseCallsAvgDuration = ({ const legendFormulas = ['Average Duration']; const expressions = [FORMULA.DATABASE_CALLS_AVG_DURATION]; const aggregateOperators = [ - MetricAggregateOperator.SUM, - MetricAggregateOperator.SUM, + MetricAggregateOperator.SUM_RATE, + MetricAggregateOperator.SUM_RATE, ]; const dataSource = DataSource.METRICS; diff --git a/frontend/src/container/MetricsApplication/MetricsPageQueries/ExternalQueries.ts b/frontend/src/container/MetricsApplication/MetricsPageQueries/ExternalQueries.ts index ef57aa764e..3375d3920a 100644 --- a/frontend/src/container/MetricsApplication/MetricsPageQueries/ExternalQueries.ts +++ b/frontend/src/container/MetricsApplication/MetricsPageQueries/ExternalQueries.ts @@ -94,8 +94,8 @@ export const externalCallErrorPercent = ({ const additionalItems = [additionalItemsA, additionalItemsB]; const aggregateOperators = [ - MetricAggregateOperator.SUM, - MetricAggregateOperator.SUM, + MetricAggregateOperator.SUM_RATE, + MetricAggregateOperator.SUM_RATE, ]; const legends = [legend, legend]; const dataSource = DataSource.METRICS; @@ -153,8 +153,8 @@ export const externalCallDuration = ({ const additionalItems = [additionalItemsA, additionalItemsA]; const legends = [legend, legend]; const aggregateOperators = [ - MetricAggregateOperator.SUM, - MetricAggregateOperator.SUM, + MetricAggregateOperator.SUM_RATE, + MetricAggregateOperator.SUM_RATE, ]; const dataSource = DataSource.METRICS; @@ -251,8 +251,8 @@ export const externalCallDurationByAddress = ({ const additionalItems = [additionalItemsA, additionalItemsA]; const legends = [legend, legend]; const aggregateOperators = [ - MetricAggregateOperator.SUM, - MetricAggregateOperator.SUM, + MetricAggregateOperator.SUM_RATE, + MetricAggregateOperator.SUM_RATE, ]; const dataSource = DataSource.METRICS; From d9950d92237dd7db3935fdb37684e64db7273ca5 Mon Sep 17 00:00:00 2001 From: Palash Gupta Date: Wed, 22 Nov 2023 19:50:04 +0530 Subject: [PATCH 5/7] fix: having white space is removed (#4025) --- .../QueryBuilder/filters/Formula/Having/HavingFilter.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frontend/src/container/QueryBuilder/filters/Formula/Having/HavingFilter.tsx b/frontend/src/container/QueryBuilder/filters/Formula/Having/HavingFilter.tsx index 008be8526d..f0944a3341 100644 --- a/frontend/src/container/QueryBuilder/filters/Formula/Having/HavingFilter.tsx +++ b/frontend/src/container/QueryBuilder/filters/Formula/Having/HavingFilter.tsx @@ -28,7 +28,7 @@ function HavingFilter({ formula, onChange }: HavingFilterProps): JSX.Element { currentFormValue.value, ); - const columnName = formula.expression.toUpperCase(); + const columnName = formula.expression.replace(/ /g, '').toUpperCase(); const aggregatorOptions: SelectOption[] = useMemo( () => [{ label: columnName, value: columnName }], From c109636889d9246cccc31bc9ff92e69ce4f4dc20 Mon Sep 17 00:00:00 2001 From: Rajat Dabade Date: Wed, 22 Nov 2023 20:32:25 +0530 Subject: [PATCH 6/7] fix: where clause issue (#4023) --- .../QueryBuilder/filters/QueryBuilderSearch/utils.ts | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/frontend/src/container/QueryBuilder/filters/QueryBuilderSearch/utils.ts b/frontend/src/container/QueryBuilder/filters/QueryBuilderSearch/utils.ts index 1859254fc4..d00a9d3fad 100644 --- a/frontend/src/container/QueryBuilder/filters/QueryBuilderSearch/utils.ts +++ b/frontend/src/container/QueryBuilder/filters/QueryBuilderSearch/utils.ts @@ -117,9 +117,15 @@ export function replaceStringWithMaxLength( array: string[], replacementString: string, ): string { - const lastSearchValue = array.pop() ?? ''; // Remove the last search value from the array - if (lastSearchValue === '') return `${mainString}${replacementString},`; // if user select direclty from options - return mainString.replace(lastSearchValue, `${replacementString},`); + const lastSearchValue = array.pop() ?? ''; + if (lastSearchValue === '') { + return `${mainString}${replacementString},`; + } + const updatedString = mainString.replace( + new RegExp(`${lastSearchValue}(?=[^${lastSearchValue}]*$)`), + replacementString, + ); + return `${updatedString},`; } export function checkCommaInValue(str: string): string { From a54cf38e21fbb3439ec8a1cc2db651da7b6cedf4 Mon Sep 17 00:00:00 2001 From: Prashant Shahi Date: Wed, 22 Nov 2023 20:51:45 +0545 Subject: [PATCH 7/7] =?UTF-8?q?chore:=20=F0=9F=93=8C=20pin=20versions:=20S?= =?UTF-8?q?igNoz=200.34.2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Prashant Shahi --- deploy/docker-swarm/clickhouse-setup/docker-compose.yaml | 4 ++-- deploy/docker/clickhouse-setup/docker-compose.yaml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/deploy/docker-swarm/clickhouse-setup/docker-compose.yaml b/deploy/docker-swarm/clickhouse-setup/docker-compose.yaml index 41ec8df235..f0ec64939b 100644 --- a/deploy/docker-swarm/clickhouse-setup/docker-compose.yaml +++ b/deploy/docker-swarm/clickhouse-setup/docker-compose.yaml @@ -146,7 +146,7 @@ services: condition: on-failure query-service: - image: signoz/query-service:0.34.1 + image: signoz/query-service:0.34.2 command: [ "-config=/root/config/prometheus.yml", @@ -186,7 +186,7 @@ services: <<: *db-depend frontend: - image: signoz/frontend:0.34.1 + image: signoz/frontend:0.34.2 deploy: restart_policy: condition: on-failure diff --git a/deploy/docker/clickhouse-setup/docker-compose.yaml b/deploy/docker/clickhouse-setup/docker-compose.yaml index 862752ab47..4edbc6561b 100644 --- a/deploy/docker/clickhouse-setup/docker-compose.yaml +++ b/deploy/docker/clickhouse-setup/docker-compose.yaml @@ -164,7 +164,7 @@ services: # Notes for Maintainers/Contributors who will change Line Numbers of Frontend & Query-Section. Please Update Line Numbers in `./scripts/commentLinesForSetup.sh` & `./CONTRIBUTING.md` query-service: - image: signoz/query-service:${DOCKER_TAG:-0.34.1} + image: signoz/query-service:${DOCKER_TAG:-0.34.2} container_name: signoz-query-service command: [ @@ -203,7 +203,7 @@ services: <<: *db-depend frontend: - image: signoz/frontend:${DOCKER_TAG:-0.34.1} + image: signoz/frontend:${DOCKER_TAG:-0.34.2} container_name: signoz-frontend restart: on-failure depends_on: