Skip to content

Commit 9ded1c1

Browse files
committed
chore: updated README
1 parent 798dc52 commit 9ded1c1

2 files changed

Lines changed: 12 additions & 4 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This Electron application demonstrates basic OpenTelemetry instrumentation for monitoring and tracing, designed to work with SigNoz Cloud for visualization. It showcases how to trace application startup, simulate long-running tasks, read file contents, and handle user interactions with OpenTelemetry in an Electron app.
44

5-
## Application Screenshot
5+
<!-- ## Application Screenshot
66
77
![Application Screenshot](PATH_TO_YOUR_APPLICATION_SCREENSHOT)
88
@@ -12,7 +12,7 @@ This screenshot shows the Electron application's interface.
1212
1313
![Backend Traces Screenshot in SigNoz Cloud](PATH_TO_YOUR_BACKEND_TRACES_SCREENSHOT)
1414
15-
The above screenshot displays the traces as they appear in SigNoz Cloud. This visualizes the telemetry data collected from the application, including trace details for application startup, simulated tasks, and user actions.
15+
The above screenshot displays the traces as they appear in SigNoz Cloud. This visualizes the telemetry data collected from the application, including trace details for application startup, simulated tasks, and user actions. -->
1616

1717
## Getting Started
1818

@@ -56,4 +56,12 @@ You should see a service called `electronjs-otel-sample-app` in your Service Tab
5656

5757
--------------------------------
5858

59+
In the `tracing.js` file, replace
60+
- {region} with the region of your SigNoz Cloud instance.
61+
- <your-signoz-ingestion-key> with the ingestion key of your SigNoz cloud instance.
62+
63+
You can find these values under **Settings -> Ingestion Settings** of your SigNoz Cloud instance.
64+
65+
--------------------------------
66+
5967
Read the comments in `tracing.js` and `index.js` files to get a better understanding of how the instrument works. OpenTelemetry doesn't provide auto-instrumentation for ElectronJS so you have to manually instrument all the functions that you want to collect the traces for.

tracing.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ const provider = new BasicTracerProvider({
1919
// Configure the OTLPTraceExporter to send traces to a specific backend.
2020
// Replace the {region} and headers with your backend's region and ingestion key.
2121
const otlpExporter = new OTLPTraceExporter({
22-
url: 'https://ingest.in.signoz.cloud:443/v1/traces', // Backend URL
22+
url: 'https://ingest.{region}.signoz.cloud:443/v1/traces', // SigNoz ingestion URL - region can be found in your SigNoz cloud settings
2323
headers: {
24-
"signoz-access-token": "b51ea17a-9ac7-4ab9-9a04-de2062dd10f5", // Authentication token
24+
"signoz-access-token": "<your-signoz-ingestion-key>", // Authentication token
2525
},
2626
});
2727

0 commit comments

Comments
 (0)