Fix placeholders in Vector, APL samples in dashboard elements (#133)

Author: tothmano

dashboard-elements/heatmap.mdx

@@ -23,6 +23,11 @@ Heatmaps represent the distribution of numerical data by grouping values into ra
 
 ## Example with Advanced Query Language
 
+```kusto
+['http-logs']
+| summarize histogram(req_duration_ms, 15) by bin_auto(_time)
+```
+
 <Frame>
   <img src="/doc-assets/shots/heatmap-apl.png" alt="Heatmap example with Advanced Query Language" />
 </Frame>

dashboard-elements/log-stream.mdx

@@ -16,6 +16,11 @@ The log stream dashboard element displays your logs as they come in real-time. E
 
 ## Example with Advanced Query Language
 
+```kusto
+['sample-http-logs']
+| project method, status, content_type
+```
+
 <Frame>
   <img src="/doc-assets/shots/log-stream-chart-apl.png" />
 </Frame>

dashboard-elements/pie-chart.mdx

@@ -23,6 +23,11 @@ Pie charts can illustrate the distribution of different types of event data. Eac
 
 ## Example with Advanced Query Language
 
+```kusto
+['http-logs']
+| summarize count() by status
+```
+
 <Frame>
   <img src="/doc-assets/shots/pie-chart-apl.png" alt="Pie chart example with Advanced Query Language" />
 </Frame>

dashboard-elements/scatter-plot.mdx

@@ -18,6 +18,11 @@ For example, plot response size against response time for an API to see if large
 
 ## Example with Advanced Query Language
 
+```kusto
+['sample-http-logs']
+| summarize avg(req_duration_ms), avg(resp_header_size_bytes) by resp_body_size_bytes
+```
+
 <Frame>
   <img src="/doc-assets/shots/scatter-chart-apl-2.png" />
 </Frame>

dashboard-elements/statistic.mdx

@@ -15,6 +15,11 @@ Statistics dashboard elements display a summary of the selected metrics over a g
 
 ## Example with Advanced Query Language
 
+```kusto
+['sample-http-logs']
+| summarize avg(resp_body_size_bytes)
+```
+
 <Frame>
   <img src="/doc-assets/shots/apl-chart-statistic-2.png" />
 </Frame>

dashboard-elements/table.mdx

@@ -17,6 +17,11 @@ The table dashboard element displays a summary of any attributes from your metri
 
 With this option, the table chart type has the capability to display a non-aggregated view of events.
 
+```kusto
+['sample-http-logs']
+| summarize avg(resp_body_size_bytes) by bin_auto(_time)
+```
+
 <Frame>
   <img src="/doc-assets/shots/table-chart-apl.png" />
 </Frame>

dashboard-elements/time-series.mdx

@@ -16,6 +16,11 @@ Time series charts show the change in your data over time which can help identif
 
 ## Example with Advanced Query Language
 
+```kusto
+['sample-http-logs']
+| summarize count() by bin_auto(_time)
+```
+
 <Frame>
   <img src="/doc-assets/shots/timeseries-chart-apl.png" />
 </Frame>

send-data/vector.mdx

@@ -10,18 +10,23 @@ isPopular: true
 popularityOrder: 3
 ---
 
+import Prerequisites from "/snippets/standard-prerequisites.mdx"
+import Replacement from "/snippets/standard-replacement.mdx"
+
 <Frame caption="Vector">
   <img src="/doc-assets/shots/vector-axiom.png" alt="Vector" />
 </Frame>
 
 Vector is a lightweight and ultra-fast tool for building observability pipelines. It has a built-in support for shipping logs to Axiom through the [`axiom` sink](https://vector.dev/docs/reference/configuration/sinks/axiom/).
 
+<Prerequisites />
+
 ## Installation
 
 Follow the [quickstart guide in the Vector documentation](https://vector.dev/docs/setup/quickstart/) to install Vector, and to configure sources and sinks.
 
 <Warning>
-If you use Vector version v0.41.1 or earlier, use the `@timestamp` field instead of `_time` to specify the timestamp of the events. For more information, see [Timestamp in legacy Vector versions](#timestamp-in-legacy-vector-versions).
+If you use Vector version v0.41.1 (released on September 11, 2024) or earlier, use the `@timestamp` field instead of `_time` to specify the timestamp of the events. For more information, see [Timestamp in legacy Vector versions](#timestamp-in-legacy-vector-versions).
 
 If you upgrade from Vector version v0.41.1 or earlier to a newer version, update your configuration. For more information, see [Upgrade from legacy Vector version](#upgrade-from-legacy-vector-version).
 </Warning>
@@ -32,9 +37,7 @@ Send data to Axiom with Vector using the [`file` method](https://vector.dev/docs
 
 The example below configures Vector to read and collect logs from files and send them to Axiom:
 
-1. [Create a dataset in Axiom](/reference/settings#data).
-2. [Generate an Axiom API token](/reference/settings#access-overview).
-3. Create a vector configuration file `vector.toml` with the following content:
+1. Create a vector configuration file `vector.toml` with the following content:
 
     ```toml
     [sources.VECTOR_SOURCE_ID]
@@ -44,18 +47,18 @@ The example below configures Vector to read and collect logs from files and send
     [sinks.SINK_ID]
     type = "axiom"
     inputs = ["VECTOR_SOURCE_ID"]
-    token = "AXIOM_API_TOKEN"
-    dataset = "AXIOM_DATASET"
+    token = "API_TOKEN"
+    dataset = "DATASET_NAME"
     ```
 
-4. In the code above, replace the following:
+1. In the code above, replace the following:
     - Replace `VECTOR_SOURCE_ID` with the Vector source ID.
     - Replace `PATH_TO_LOGS` with the path to the log files. For example, `/var/log/**/*.log`.
     - Replace `SINK_ID` with the sink ID.
-    - Replace `AXIOM_API_TOKEN` with the Axiom API token you have generated.
-    - Replace `AXIOM_DATASET` with the name of the Axiom dataset where you want to send data.
+    {/* list separator */}
+    <Replacement />
 
-5. Run Vector to send logs to Axiom.
+1. Run Vector to send logs to Axiom.
 
 ### Example with data transformation
 
@@ -76,11 +79,13 @@ source = '''
 [sinks.SINK_ID]
 type = "axiom"
 inputs = ["filter_json_fields"]
-token = "AXIOM_API_TOKEN"
-dataset = "AXIOM_DATASET"
+token = "API_TOKEN"
+dataset = "DATASET_NAME"
 ```
 
-Replace `FIELD_TO_REMOVE` with the field you want to remove.
+- Replace `FIELD_TO_REMOVE` with the field you want to remove.
+{/* list separator */}
+<Replacement />
 
 <Note>
 Any changes to Vector’s `file` method can make the code example above outdated. If this happens, please refer to the [official Vector documentation on the `file` method](https://vector.dev/docs/reference/configuration/sources/file/), and we kindly ask you to inform us of the issue using the feedback tool at the bottom of this page.
@@ -112,17 +117,11 @@ timezone = "local"
 [sinks.axiom]
 type = "axiom"
 inputs = ["my_source_id"]
-token = "xaat-1234"
-dataset = "vector-dev"
+token = "API_TOKEN"
+dataset = "DATASET_NAME"
 ```
 
-DATASET is the name of your dataset. When logs are sent from your vector, it’s stored in a dataset in Axiom.
-
-[See creating a dataset for more](/reference/datasets)
-
-TOKEN is used to ingest or query data to your dataset. API token can be generated from settings on Axiom dashboard.
-
-[See creating an API token for more](/reference/tokens)
+<Replacement />
 
 ## Send Docker logs to Axiom
 
@@ -138,13 +137,13 @@ docker_host = "unix:///var/run/docker.sock"
 [sinks.axiom]
 type = "axiom"
 inputs = ["docker_logs"]
-dataset = "your_dataset_name"  # replace with the name of your Axiom dataset
-token = "your_api_token"  # replace with your Axiom API token
+dataset = "DATASET_NAME"
+token = "API_TOKEN"
 ```
 
-Replace `your_dataset_name` with the name of the [dataset](/reference/datasets) you want to send logs to in Axiom, and `your_api_token` with your [Axiom API token](/reference/tokens).
+<Replacement />
 
-- Run Vector: Start Vector with the configuration file you just created:
+Run Vector: Start Vector with the configuration file you just created:
 
 ```bash
 vector --config /path/to/vector.toml
@@ -165,10 +164,12 @@ region = "us-west-2"  # replace with the AWS region of your bucket
 [sinks.axiom]
 type = "axiom"
 inputs = ["my_s3_source"]
-dataset = "your_dataset_name"  # replace with the name of your Axiom dataset
-token = "your_api_token"  # replace with your Axiom API token
+dataset = "DATASET_NAME"
+token = "API_TOKEN"
 ```
 
+<Replacement />
+
 Finally, run Vector with the configuration file using `vector --config ./vector.toml`. This starts Vector and begins reading logs from the specified S3 bucket and sending them to the specified Axiom dataset.
 
 ## Send Kafka logs to Axiom
@@ -186,10 +187,12 @@ auto_offset_reset = "earliest" # start reading from the beginning
 [sinks.axiom]
 type = "axiom"
 inputs = ["my_kafka_source"]  # connect the Axiom sink to your Kafka source
-dataset = "your_dataset_name"  # replace with the name of your Axiom dataset
-token = "your_api_token"  # replace with your Axiom API token
+dataset = "DATASET_NAME"  # replace with the name of your Axiom dataset
+token = "API_TOKEN"  # replace with your Axiom API token
 ```
 
+<Replacement />
+
 Finally, you can start Vector with your configuration file: `vector --config /path/to/your/vector.toml`
 
 ## Send NGINX metrics to Axiom
@@ -230,10 +233,12 @@ endpoints = ["http://localhost/metrics"] # the endpoint where NGINX metrics are
 [sinks.axiom]
 type = "axiom" # must be: axiom
 inputs = ["nginx_metrics"] # use the metrics from the NGINX source
-dataset = "your_dataset_name"  # replace with the name of your Axiom dataset
-token = "your_api_token"  # replace with your Axiom API token
+dataset = "DATASET_NAME"  # replace with the name of your Axiom dataset
+token = "API_TOKEN"  # replace with your Axiom API token
 ```
 
+<Replacement />
+
 Finally, you can start Vector with your configuration file: `vector --config /path/to/your/vector.toml`
 
 ## Send Syslog logs to Axiom
@@ -250,10 +255,12 @@ mode="tcp"
 [sinks.axiom]
 type="axiom"
 inputs = [ "my_source_id" ] # required
-dataset="your_dataset_name" # replace with the name of your Axiom dataset
-token="your_api_token" # replace with your Axiom API token
+dataset="DATASET_NAME" # replace with the name of your Axiom dataset
+token="API_TOKEN" # replace with your Axiom API token
 ```
 
+<Replacement />
+
 ## Send Prometheus metrics to Axiom
 
 To send Prometheus scrape metrics using the Axiom sink, you need to create a configuration file, for example, `vector.toml`, with the following code:
@@ -268,17 +275,19 @@ endpoints = ["http://localhost:9090/metrics"]  # replace with your Prometheus en
 [sinks.axiom]
 type = "axiom"  # Axiom type
 inputs = ["my_prometheus_source"]  # connect the Axiom sink to your Prometheus source
-dataset = "your_prometheus_dataset"  # replace with the name of your Axiom dataset
-token = "your_api_token"  # replace with your Axiom API token
+dataset = "DATASET_NAME"  # replace with the name of your Axiom dataset
+token = "API_TOKEN"  # replace with your Axiom API token
 ```
 
+<Replacement />
+
 Check out the [advanced configuration on Batch, Buffer configuration, and Encoding on Vector Documentation](https://vector.dev/docs/reference/configuration/sinks/axiom/)
 
 ## Timestamp in legacy Vector versions
 
-If you use Vector version v0.41.1 or earlier, use the `@timestamp` field instead of `_time` to specify the timestamp in the event data you send to Axiom. For example: `{"@timestamp":"2022-04-14T21:30:30.658Z..."}`. For more information, see [Requirements of the timestamp field](/reference/field-restrictions#requirements-of-the-timestamp-field). In the case of Vector version v0.41.1 or earlier, the requirements explained on the page apply to the `@timestamp` field, not to `_time`.
+If you use Vector version v0.41.1 (released on September 11, 2024) or earlier, use the `@timestamp` field instead of `_time` to specify the timestamp in the event data you send to Axiom. For example: `{"@timestamp":"2022-04-14T21:30:30.658Z..."}`. For more information, see [Requirements of the timestamp field](/reference/field-restrictions#requirements-of-the-timestamp-field). In the case of Vector version v0.41.1 or earlier, the requirements explained on the page apply to the `@timestamp` field, not to `_time`.
 
-If you use Vector version v0.42.0 or newer, use the `_time` field as usual for other collectors.
+If you use Vector version v0.42.0 (released on October 21, 2024) or newer, use the `_time` field as usual for other collectors.
 
 ### Upgrade from legacy Vector version
 
@@ -307,8 +316,8 @@ file= 'example.vrl' # See above
 [sinks.debug]
 type = "axiom"
 inputs = [ "migrate" ]
-dataset = "my-axiom-dataset" # No change
-token = "your-token" # No change
+dataset = "DATASET_NAME" # No change
+token = "API_TOKEN" # No change
 
 [sinks.debug.encoding]
 codec = "json"
@@ -332,9 +341,9 @@ file= 'example.vrl' # See above
 type = "axiom"
 compression = "gzip" # Set the compression algorithm
 inputs = [ "migrate" ]
-dataset = "my-axiom-dataset" # No change
-token = "your-token" # No change
+dataset = "DATASET_NAME" # No change
+token = "API_TOKEN" # No change
 
 [sinks.debug.encoding]
 codec = "json"
-```
+```