Standardise use of placeholders (#161)

Author: tothmano

apps/cloudflare-workers.mdx

@@ -7,7 +7,7 @@ tags:
 ---
 
 import Prerequisites from "/snippets/standard-prerequisites.mdx"
-import Replacement from "/snippets/standard-replacement.mdx"
+import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
 
 The Axiom Cloudflare Workers app provides granular detail about the traffic coming in from your monitored sites. This includes edge requests, static resources, client auth, response duration, and status. Axiom gives you an all-at-once view of key Cloudflare Workers metrics and logs, out of the box, with our dynamic Cloudflare Workers dashboard.
 
@@ -34,7 +34,7 @@ Axiom Cloudflare Workers is an open-source project and welcomes your contributio
     const axiomToken = "API_TOKEN"
     ```
 
-    <Replacement />
+    <ReplaceDatasetToken />
 
 1. Add triggers for the worker. For example, add a route trigger using the [Cloudflare documentation](https://developers.cloudflare.com/workers/configuration/routing/routes/#set-up-a-route-in-the-dashboard).
 

guides/javascript.mdx

@@ -11,7 +11,7 @@ popularityOrder: 8
 ---
 
 import Prerequisites from "/snippets/standard-prerequisites.mdx"
-import Replacement from "/snippets/api-token-replacement.mdx"
+import ReplaceDataset from "/snippets/replace-dataset.mdx"
 
 JavaScript is a versatile, high-level programming language primarily used for creating dynamic and interactive web content.
 
@@ -66,8 +66,6 @@ Configure the environment variables in one of the following ways:
     });
     ```
 
-    <Replacement />
-
 - Install the [Axiom CLI](/reference/cli), and then run the following command:
 
     ```sh
@@ -83,6 +81,8 @@ axiom.ingest('DATASET_NAME', [{ foo: 'bar' }]);
 await axiom.flush();
 ```
 
+<ReplaceDataset />
+
 The client automatically batches events in the background. In most cases, call `flush()` only before your application exits.
 
 ### Query data
@@ -94,6 +94,8 @@ const res = await axiom.query(`['DATASET_NAME'] | where foo == 'bar' | limit 100
 console.log(res);
 ```
 
+<ReplaceDataset />
+
 For more examples, see the [examples in GitHub](https://github.com/axiomhq/axiom-js/tree/main/examples).
 
 ### Capture errors
@@ -163,8 +165,6 @@ const logger = new Logger(
 logger.info("Hello, world!");
 ```
 
-<Replacement />
-
 #### Transports
 
 The `@axiomhq/logging` library includes the following transports:

guides/opentelemetry-cloudflare-workers.mdx

@@ -86,8 +86,8 @@ main = "index.ts"
 
 # Define environment variables here
 [vars]
-AXIOM_API_TOKEN = "$API_TOKEN" # Replace $API_TOKEN with your actual Axiom API token
-AXIOM_DATASET = "$DATASET" # Replace $DATASET with your actual Axiom dataset name
+AXIOM_API_TOKEN = "API_TOKEN" # Replace API_TOKEN with your actual Axiom API token
+AXIOM_DATASET = "DATASET_NAME" # Replace DATASET_NAME with your actual Axiom dataset name
 ```
 
 ## Install Dependencies

guides/opentelemetry-django.mdx

@@ -117,8 +117,8 @@ provider = TracerProvider(resource=resource)
 otlp_exporter = OTLPSpanExporter(
     endpoint="https://api.axiom.co/v1/traces",
     headers={
-        "Authorization": "Bearer YOUR_API_TOKEN",  # Replace with your actual API token
-        "X-Axiom-Dataset": "YOUR_DATASET_NAME"    # Replace with your dataset name
+        "Authorization": "Bearer API_TOKEN",  # Replace with your actual API token
+        "X-Axiom-Dataset": "DATASET_NAME"    # Replace with your dataset name
     }
 )
 
@@ -222,7 +222,7 @@ def configure_opentelemetry():
     trace.set_tracer_provider(TracerProvider(resource=resource))
     otlp_exporter = OTLPSpanExporter(
         endpoint="https://api.axiom.co/v1/traces",
-        headers={"Authorization": "Bearer YOUR_API_TOKEN", "X-Axiom-Dataset": "YOUR_DATASET_NAME"}
+        headers={"Authorization": "Bearer API_TOKEN", "X-Axiom-Dataset": "DATASET_NAME"}
     )
     span_processor = BatchSpanProcessor(otlp_exporter)
     trace.get_tracer_provider().add_span_processor(span_processor)
@@ -308,7 +308,7 @@ def configure_opentelemetry():
     trace.set_tracer_provider(TracerProvider(resource=resource))
     otlp_exporter = OTLPSpanExporter(
         endpoint="https://api.axiom.co/v1/traces",
-        headers={"Authorization": "Bearer YOUR_API_TOKEN", "X-Axiom-Dataset": "YOUR_DATASET_NAME"}
+        headers={"Authorization": "Bearer API_TOKEN", "X-Axiom-Dataset": "DATASET_NAME"}
     )
     span_processor = BatchSpanProcessor(otlp_exporter)
     trace.get_tracer_provider().add_span_processor(span_processor)

guides/opentelemetry-dotnet.mdx

@@ -255,8 +255,8 @@ Sdk.CreateTracerProviderBuilder()
     .AddOtlpExporter(options =>
     {
         options.Endpoint = new Uri("https://api.axiom.co/v1/traces");
-        // Ensure to replace YOUR_API_TOKEN and YOUR_DATASET_NAME with your actual API token and dataset name
-        options.Headers = $"Authorization=Bearer YOUR_API_TOKEN, X-Axiom-Dataset=YOUR_DATASET_NAME";
+        // Replace API_TOKEN and DATASET_NAME with your actual API token and dataset name
+        options.Headers = $"Authorization=Bearer API_TOKEN, X-Axiom-Dataset=DATASET_NAME";
     })
     .Build();
 ```

guides/opentelemetry-go.mdx

@@ -7,6 +7,8 @@ tags: ['guides', 'golang', 'go', 'otel', 'opentelemetry']
 logoId: 'openTelemetry'
 ---
 
+import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
+
 OpenTelemetry offers a [single set of APIs and libraries](https://opentelemetry.io/docs/languages/go/instrumentation/) that standardize how you collect and transfer telemetry data. This guide focuses on setting up OpenTelemetry in a Go app to send traces to Axiom.
 
 ## Prerequisites
@@ -222,7 +224,7 @@ const (
    serviceName           = "axiom-go-otel" // Name of the service for tracing.
    serviceVersion        = "0.1.0" // Version of the service.
    otlpEndpoint          = "api.axiom.co" // OTLP collector endpoint.
-   bearerToken           = "Bearer $API_TOKEN" // Authorization token.
+   bearerToken           = "Bearer API_TOKEN" // Authorization token.
    deploymentEnvironment = "production" // Deployment environment.
 )
 
@@ -247,7 +249,7 @@ func InstallExportPipeline(ctx context.Context) (func(context.Context) error, er
        otlptracehttp.WithEndpoint(otlpEndpoint),
        otlptracehttp.WithHeaders(map[string]string{
            "Authorization":   bearerToken,
-           "X-AXIOM-DATASET": "$DATASET_NAME",
+           "X-AXIOM-DATASET": "DATASET_NAME",
        }),
        otlptracehttp.WithTLSClientConfig(&tls.Config{}),
    )
@@ -272,6 +274,8 @@ func InstallExportPipeline(ctx context.Context) (func(context.Context) error, er
 }
 ```
 
+<ReplaceDatasetToken />
+
 ## Run the app
 
 To run the app, execute both `exporter.go` and `main.go`. Use the command `go run main.go exporter.go` to start the app. Once your app is running, traces collected by your app are exported to Axiom. The server starts on the specified port, and you can interact with it by sending requests to the `/rolldice` endpoint.

guides/opentelemetry-java.mdx

@@ -8,7 +8,7 @@ logoId: 'openTelemetry'
 ---
 
 import Prerequisites from "/snippets/standard-prerequisites.mdx"
-import Replacement from "/snippets/standard-replacement.mdx"
+import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
 
 OpenTelemetry provides a unified approach to collecting telemetry data from your Java applications. This page demonstrates how to configure OpenTelemetry in a Java app to send telemetry data to Axiom using the OpenTelemetry SDK.
 
@@ -144,7 +144,7 @@ public class OtelConfiguration {
 }
 ```
 
-<Replacement />
+<ReplaceDatasetToken />
 
 ## Configure project
 

guides/opentelemetry-nextjs.mdx

@@ -293,7 +293,7 @@ export function register() {
         url: 'https://api.axiom.co/v1/traces',
         headers: {
           Authorization: `Bearer ${process.env.API_TOKEN}`,
-          'X-Axiom-Dataset': `${process.env.DATASET_NAME_NAME}`,
+          'X-Axiom-Dataset': `${process.env.DATASET_NAME}`,
         },
       })
     ),

guides/opentelemetry-nodejs.mdx

@@ -7,6 +7,8 @@ tags: ['guides', 'nodejs', 'typescript', 'javascript', 'js', 'ts', 'otel', 'open
 logoId: 'openTelemetry'
 ---
 
+import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
+
 OpenTelemetry provides a [unified approach to collecting telemetry data](https://opentelemetry.io/docs/languages/js/instrumentation/) from your Node.js and TypeScript apps. This guide demonstrates how to configure OpenTelemetry in a Node.js app to send telemetry data to Axiom using OpenTelemetry SDK.
 
 ## Prerequisites
@@ -110,8 +112,8 @@ import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'
 const traceExporter = new OTLPTraceExporter({
   url: 'https://api.axiom.co/v1/traces',
   headers: {
-    'Authorization': 'Bearer $API_TOKEN',
-    'X-Axiom-Dataset': '$DATASET'
+    'Authorization': 'Bearer API_TOKEN',
+    'X-Axiom-Dataset': 'DATASET_NAME'
   },
 });
 
@@ -136,6 +138,8 @@ const sdk = new NodeSDK({
 sdk.start();
 ```
 
+<ReplaceDatasetToken />
+
 ## Installing the Dependencies
 
 Navigate to the root directory of your project and run the following command to install the required dependencies:

guides/send-logs-from-apache-log4j.mdx

@@ -9,7 +9,7 @@ enlargeLogo: true
 ---
 
 import Prerequisites from "/snippets/standard-prerequisites.mdx"
-import Replacement from "/snippets/standard-replacement.mdx"
+import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
 
 Log4j is a Java logging framework developed by the Apache Software Foundation and widely used in the Java community. This page covers how to get started with Log4j, configure it to forward log messages to Fluentd, and send logs to Axiom.
 
@@ -369,7 +369,7 @@ To configure Fluentd, create a configuration file. Create a new file named `flue
 </match>
 ```
 
-<Replacement />
+<ReplaceDatasetToken />
 
 This configuration does the following:
 

guides/send-logs-from-laravel.mdx

@@ -7,6 +7,8 @@ tags: ['guides', 'laravel', 'php']
 logoId: 'laravel'
 ---
 
+import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
+
 This guide explains integrating Axiom as a logging solution in a Laravel app. Using Axiom’s capabilities with a custom log channel, you can efficiently send your app’s logs to Axiom for storage, analysis, and monitoring. This integration uses Monolog, Laravel’s underlying logging library, to create a custom logging handler that forwards logs to Axiom.
 
 ## Prerequisites
@@ -130,12 +132,14 @@ The `default` configuration specifies the primary channel Laravel uses for loggi
 
 ```bash
 LOG_CHANNEL=axiom
-AXIOM_API_TOKEN=$API_TOKEN
-AXIOM_DATASET=$DATASET
+AXIOM_API_TOKEN=API_TOKEN
+AXIOM_DATASET=DATASET_NAME
 LOG_LEVEL=debug
 LOG_DEPRECATIONS_CHANNEL=null
 ```
 
+<ReplaceDatasetToken />
+
 ### Deprecations log channel
 
 The `deprecations` channel is configured to handle logs about deprecated features in PHP and libraries, helping you prepare for updates. By default, it’s set to ignore these warnings, but you can adjust this to direct deprecation logs to a specific channel if needed.

guides/send-logs-from-ruby-on-rails.mdx

@@ -7,6 +7,8 @@ tags: ['guides', 'ruby on rails', 'faraday']
 logoId: 'ruby'
 ---
 
+import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
+
 This guide provides step-by-step instructions on how to send logs from a Ruby on Rails application to Axiom using the Faraday library. By following this guide, you configure your Rails app to send logs to Axiom, allowing you to monitor and analyze your application logs effectively.
 
 ## Prerequisites
@@ -48,7 +50,7 @@ require 'json'
 class AxiomLogger
   def self.send_log(log_data)
     dataset_name = "DATASET_NAME"
-    axiom_ingest_api_url = "https://api.axiom.co/v1/datasets/#{dataset_name}/ingest"
+    axiom_ingest_api_url = "https://api.axiom.co/v1/datasets/DATASET_NAME/ingest"
     ingest_token = "API_TOKEN"
 
     conn = Faraday.new(url: axiom_ingest_api_url) do |faraday|
@@ -75,8 +77,7 @@ end
 
 In the code above, make the following changes:
 
-- Replace `API_TOKEN` with your Axiom API key.
-- Replace `DATASET_NAME` with the name of the Axiom dataset where you want to send data.
+<ReplaceDatasetToken />
 
 ## Test with the Axiom logger
 

guides/winston.mdx

@@ -7,6 +7,7 @@ tags: ['js', 'pino', 'winston', 'node', 'javascript', 'typescript', 'ts']
 logoId: 'winston'
 ---
 
+import ReplaceDatasetToken from "/snippets/replace-dataset-token.mdx"
 import Prerequisites from "/snippets/standard-prerequisites.mdx"
 
 <Prerequisites />
@@ -36,13 +37,15 @@ const logger = winston.createLogger({
         // You can pass an option here. If you don’t, the transport is configured automatically
         // using environment variables like `AXIOM_DATASET` and `AXIOM_TOKEN`
         new AxiomTransport({
-            dataset: 'my-dataset',
-            token: 'my-token',
+            dataset: 'DATASET_NAME',
+            token: 'API_TOKEN',
         }),
     ],
 });
 ```
 
+<ReplaceDatasetToken />
+
 After setting up the Axiom transport for Winston, use the logger as usual:
 
 ```js

restapi/endpoints/deleteDataset.mdx

@@ -1,4 +1,4 @@
 ---
 title: Delete dataset
-openapi: "v1 delete /datasets/{id}"
+openapi: "v1 delete /datasets/{dataset_name}"
 ---

restapi/endpoints/getDataset.mdx

@@ -1,4 +1,4 @@
 ---
 title: Retrieve dataset
-openapi: "v1 get /datasets/{id}"
+openapi: "v1 get /datasets/{dataset_name}"
 ---

restapi/endpoints/ingestIntoDataset.mdx

@@ -1,4 +1,4 @@
 ---
 title: Ingest data
-openapi: "v1 post /datasets/{id}/ingest"
+openapi: "v1 post /datasets/{dataset_name}/ingest"
 ---

restapi/endpoints/queryDataset.mdx

@@ -1,4 +1,4 @@
 ---
 title: Run query (legacy)
-openapi: "v1 post /datasets/{id}/query"
+openapi: "v1 post /datasets/{dataset_name}/query"
 ---

restapi/endpoints/trimDataset.mdx

@@ -1,4 +1,4 @@
 ---
 title: Trim dataset
-openapi: "v1 post /datasets/{id}/trim"
+openapi: "v1 post /datasets/{dataset_name}/trim"
 ---

restapi/endpoints/updateDataset.mdx

@@ -1,4 +1,4 @@
 ---
 title: Update dataset
-openapi: "v1 put /datasets/{id}"
+openapi: "v1 put /datasets/{dataset_name}"
 ---

restapi/ingest.mdx

@@ -59,8 +59,8 @@ The following example request contains grouped events. The structure of the `JSO
 ### Example Request using JSON
 
 ```bash
-curl -X 'POST' 'https://api.axiom.co/v1/datasets/$DATASET_NAME/ingest' \
-  -H 'Authorization: Bearer $API_TOKEN' \
+curl -X 'POST' 'https://api.axiom.co/v1/datasets/{dataset_name}/ingest' \
+  -H 'Authorization: Bearer API_TOKEN' \
   -H 'Content-Type: application/json' \
   -d '[
         {
@@ -92,8 +92,8 @@ A successful POST Request returns a `200` response code JSON with details:
 ### Example Request using Nested Arrays
 
 ```bash
-curl -X 'POST' 'https://api.axiom.co/v1/datasets/$DATASET_NAME/ingest' \
-  -H 'Authorization: Bearer $API_TOKEN' \
+curl -X 'POST' 'https://api.axiom.co/v1/datasets/{dataset_name}/ingest' \
+  -H 'Authorization: Bearer API_TOKEN' \
   -H 'Content-Type: application/json' \
   -d '[
         {
@@ -155,8 +155,8 @@ A successful POST Request returns a `200` response code JSON with details:
 ### Example Request using Objects, Strings, and Arrays
 
 ```bash
-curl -X 'POST' 'https://api.axiom.co/v1/datasets/$DATASET_NAME/ingest' \
-  -H 'Authorization: Bearer $API_TOKEN' \
+curl -X 'POST' 'https://api.axiom.co/v1/datasets/{dataset_name}/ingest' \
+  -H 'Authorization: Bearer API_TOKEN' \
   -H 'Content-Type: application/json' \
   -d '[{ "axiom": {
     "logging": {
@@ -213,8 +213,8 @@ The following example request contains events. The structure of the `CSV` payloa
 ### Example Request using CSV
 
 ```bash
-curl -X 'POST' 'https://api.axiom.co/v1/datasets/$DATASET_NAME/ingest' \
-      -H 'Authorization: Bearer $API_TOKEN' \
+curl -X 'POST' 'https://api.axiom.co/v1/datasets/{dataset_name}/ingest' \
+      -H 'Authorization: Bearer API_TOKEN' \
       -H 'Content-Type: text/csv' \
       -d 'user, name
          foo, bar'