docs: added ror onboarding docs (#3927)

* docs: added ror onboarding docs * feat: add ror docs * feat: update ror details in connection status --------- Co-authored-by: Yunus A M <myounis.ar@live.com> Co-authored-by: Vishal Sharma <makeavish786@gmail.com>
SigNoz · Nov 10, 2023 · 6b2f857 · 6b2f857
1 parent 30b0d42
commit 6b2f857
Show file tree

Hide file tree

Showing 9 changed files with 395 additions and 118 deletions.
diff --git a/frontend/src/container/OnboardingContainer/APM/APM.tsx b/frontend/src/container/OnboardingContainer/APM/APM.tsx
@@ -12,6 +12,7 @@ import GoLang from './GoLang/GoLang';
 import Java from './Java/Java';
 import Javascript from './Javascript/Javascript';
 import Python from './Python/Python';
+import RoR from './RubyOnRails/ROR';
 
 interface IngestionInfoProps {
 	SIGNOZ_INGESTION_KEY?: string;
@@ -39,6 +40,10 @@ const supportedLanguages = [
 		name: 'go',
 		imgURL: `Logos/java.png`,
 	},
+	{
+		name: 'rails',
+		imgURL: `Logos/rails.png`,
+	},
 ];
 
 export default function APM({
@@ -91,6 +96,8 @@ export default function APM({
 				return <Javascript ingestionInfo={ingestionInfo} activeStep={activeStep} />;
 			case 'go':
 				return <GoLang ingestionInfo={ingestionInfo} activeStep={activeStep} />;
+			case 'rails':
+				return <RoR ingestionInfo={ingestionInfo} activeStep={activeStep} />;
 			default:
 				return <> </>;
 		}

diff --git a/frontend/src/container/OnboardingContainer/APM/Javascript/md-docs/express.md b/frontend/src/container/OnboardingContainer/APM/Javascript/md-docs/express.md
@@ -20,10 +20,10 @@ From VMs, there are two ways to send data to SigNoz Cloud.
 Step 1. Install OpenTelemetry packages
 
 ```bash
-npm install --save @opentelemetry/api@^1.4.1                                                                       
-npm install --save @opentelemetry/sdk-node@^0.39.1
-npm install --save @opentelemetry/auto-instrumentations-node@^0.37.0
-npm install --save @opentelemetry/exporter-trace-otlp-http@^0.39.1
+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
@@ -87,10 +87,10 @@ You can find instructions to install OTel Collector binary [here](https://signoz
 Step 1. Install OpenTelemetry packages
 
 ```js
-npm install --save @opentelemetry/api@^1.4.1
-npm install --save @opentelemetry/sdk-node@^0.39.1
-npm install --save @opentelemetry/auto-instrumentations-node@^0.37.0
-npm install --save @opentelemetry/exporter-trace-otlp-http@^0.39.1
+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
@@ -148,10 +148,10 @@ Once you have set up OTel Collector agent, you can proceed with OpenTelemetry Ja
 Step 1. Install OpenTelemetry packages
 
 ```bash
-npm install --save @opentelemetry/api@^1.4.1
-npm install --save @opentelemetry/sdk-node@^0.39.1
-npm install --save @opentelemetry/auto-instrumentations-node@^0.37.0
-npm install --save @opentelemetry/exporter-trace-otlp-http@^0.39.1
+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

diff --git a/frontend/src/container/OnboardingContainer/APM/Javascript/md-docs/javascript.md b/frontend/src/container/OnboardingContainer/APM/Javascript/md-docs/javascript.md
@@ -18,10 +18,10 @@ From VMs, there are two ways to send data to SigNoz Cloud.
 Step 1. Install OpenTelemetry packages
 
 ```bash
-npm install --save @opentelemetry/api@^1.4.1                                                                       
-npm install --save @opentelemetry/sdk-node@^0.39.1
-npm install --save @opentelemetry/auto-instrumentations-node@^0.37.0
-npm install --save @opentelemetry/exporter-trace-otlp-http@^0.39.1
+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
@@ -86,10 +86,10 @@ You can find instructions to install OTel Collector binary [here](https://signoz
 Step 1. Install OpenTelemetry packages
 
 ```js
-npm install --save @opentelemetry/api@^1.4.1
-npm install --save @opentelemetry/sdk-node@^0.39.1
-npm install --save @opentelemetry/auto-instrumentations-node@^0.37.0
-npm install --save @opentelemetry/exporter-trace-otlp-http@^0.39.1
+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
@@ -149,10 +149,10 @@ Once you have set up OTel Collector agent, you can proceed with OpenTelemetry Ja
 Step 1. Install OpenTelemetry packages
 
 ```js
-npm install --save @opentelemetry/api@^1.4.1
-npm install --save @opentelemetry/sdk-node@^0.39.1
-npm install --save @opentelemetry/auto-instrumentations-node@^0.37.0
-npm install --save @opentelemetry/exporter-trace-otlp-http@^0.39.1
+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

diff --git a/frontend/src/container/OnboardingContainer/APM/Javascript/md-docs/nestjs.md b/frontend/src/container/OnboardingContainer/APM/Javascript/md-docs/nestjs.md
@@ -20,51 +20,54 @@ From VMs, there are two ways to send data to SigNoz Cloud.
 Step 1. Install OpenTelemetry packages
 
 ```bash
-npm install --save @opentelemetry/api@^1.4.1                                                                       
-npm install --save @opentelemetry/sdk-node@^0.39.1
-npm install --save @opentelemetry/auto-instrumentations-node@^0.37.0
-npm install --save @opentelemetry/exporter-trace-otlp-http@^0.39.1
+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 `tracer.ts` file
 
 This file will have your SigNoz cloud endpoint and service name configued as values of `url` and `SERVICE_NAME` respectively.
 
 ```js
-'use strict'
-const process = require('process');
-const opentelemetry = require('@opentelemetry/sdk-node');
-const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
-const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');
-const {Resource} = require('@opentelemetry/resources');
-const {SemanticResourceAttributes} = require('@opentelemetry/semantic-conventions');
+'use strict';
 
+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: 'https://ingest.{{REGION}}.signoz.cloud:443/v1/traces'
-  }
+  url: 'https://ingest.{{REGION}}.signoz.cloud:443/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()
+    [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));
-    });
-    
-  module.exports = sdk
+});
+
+export default sdk;
 ```
 
 Step 3. Import the tracer module where your app starts  `(Ex —> main.ts)`
@@ -112,52 +115,54 @@ You can find instructions to install OTel Collector binary [here](https://signoz
 Step 1. Install OpenTelemetry packages
 
 ```js
-npm install --save @opentelemetry/api@^1.4.1
-npm install --save @opentelemetry/sdk-node@^0.39.1
-npm install --save @opentelemetry/auto-instrumentations-node@^0.37.0
-npm install --save @opentelemetry/exporter-trace-otlp-http@^0.39.1
+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 `tracer.ts` file
 
 This file will have your service name configued as value for `SERVICE_NAME`.
 
 ```js
-'use strict'
-const process = require('process');
-//OpenTelemetry
-const opentelemetry = require('@opentelemetry/sdk-node');
-const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
-const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');
-const {Resource} = require('@opentelemetry/resources');
-const {SemanticResourceAttributes} = require('@opentelemetry/semantic-conventions');
+'use strict';
+
+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'
-  }
+  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()
+    [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));
-    });
-    
-  module.exports = sdk
+});
+
+export default sdk;
 ```
 
 Step 3. Import the tracer module where your app starts
@@ -200,52 +205,54 @@ Once you have set up OTel Collector agent, you can proceed with OpenTelemetry Ja
 Step 1. Install OpenTelemetry packages
 
 ```bash
-npm install --save @opentelemetry/api@^1.4.1
-npm install --save @opentelemetry/sdk-node@^0.39.1
-npm install --save @opentelemetry/auto-instrumentations-node@^0.37.0
-npm install --save @opentelemetry/exporter-trace-otlp-http@^0.39.1
+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 `tracer.ts` file
 
 This file will have your service name configued as value for `SERVICE_NAME`.
 
 ```js
-'use strict'
-const process = require('process');
-//OpenTelemetry
-const opentelemetry = require('@opentelemetry/sdk-node');
-const { getNodeAutoInstrumentations } = require('@opentelemetry/auto-instrumentations-node');
-const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');
-const {Resource} = require('@opentelemetry/resources');
-const {SemanticResourceAttributes} = require('@opentelemetry/semantic-conventions');
+'use strict';
+
+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'
-  }
+  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()
+    [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));
-    });
-    
-  module.exports = sdk
+});
+
+export default sdk;
 ```
 
 Step 3. Import the tracer module where your app starts

diff --git a/frontend/src/container/OnboardingContainer/APM/RubyOnRails/ROR.styles.scss b/frontend/src/container/OnboardingContainer/APM/RubyOnRails/ROR.styles.scss