From c76b3d618748d9a6a472b05fc45d64cad7810297 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9Cnico-shishkin=E2=80=9D?=
<“nicoshishkinatlogz@outlook.com”>
Date: Sun, 19 May 2024 12:48:00 +0100
Subject: [PATCH 01/13] DOC-868
---
.../admin/give-aws-access-with-iam-roles.md | 24 ++++++++++---------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/docs/user-guide/admin/give-aws-access-with-iam-roles.md b/docs/user-guide/admin/give-aws-access-with-iam-roles.md
index 50018481..b197a286 100644
--- a/docs/user-guide/admin/give-aws-access-with-iam-roles.md
+++ b/docs/user-guide/admin/give-aws-access-with-iam-roles.md
@@ -60,27 +60,29 @@ To do this, add the following to your IAM policy:
Note that the ListBucket permission is set to the entire bucket and the GetObject permission ends with a /* suffix, so we can get files in subdirectories.
:::
-### Create a Logz.io-AWS connector
+### Create a Logz.io-AWS Connector for Archive Setup
-In your Logz.io app, go to the **Integration hub** and select the relevant AWS resource.
+1. In your Logz.io app, go to the **Integration hub** and select the relevant AWS resource.
-Inside the integration, click **+ Add a bucket** and select the option to **Authenticate with a role**
+2. Inside the integration, click **+ Add a bucket** and select the option to **Authenticate with a role**.
-
+3. Copy and paste the **Account ID** and the **External ID** into your text editor.
-Copy and paste the **Account ID** and the **External ID** in your text editor.
+4. Fill in the form to create a new connector:
+ - Enter the **S3 bucket name**.
+ - Enter the **Prefix** where your logs are stored, if applicable.
-Fill in the form to create a new connector.
+5. Click **Get the role policy**.
+ - Review the role policy to confirm the required permissions.
+ - Paste the policy into your text editor.
-Enter the **S3 bucket name** and, if needed,
-the **Prefix** where your logs are stored.
+6. Follow the role creation process using the information from the role policy.
-Click **Get the role policy**.
-You can review the role policy to confirm the permissions that will be needed.
-Paste the policy in your text editor.
+7. Once the role is created, paste the resulting **Role ARN** within the Archive setup in Logz.io.
Keep this information available so you can use it in AWS.
+
### Create the policy in AWS
Navigate to [IAM policies](https://us-east-1.console.aws.amazon.com/iam/home#/policies) and click **Create policy**.
From 59ec7badb9d1b6d057f35fabe43b0b071f02a1fe Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9Cnico-shishkin=E2=80=9D?=
<“nicoshishkinatlogz@outlook.com”>
Date: Mon, 12 Aug 2024 00:24:31 +0100
Subject: [PATCH 02/13] Node logs
---
docs/shipping/Code/node-js.md | 166 ++++++++++++++++++++++++++++++++++
1 file changed, 166 insertions(+)
diff --git a/docs/shipping/Code/node-js.md b/docs/shipping/Code/node-js.md
index 9689ed36..efb96150 100644
--- a/docs/shipping/Code/node-js.md
+++ b/docs/shipping/Code/node-js.md
@@ -360,8 +360,174 @@ logger.log(obj);
```
+
+
+### Prerequisites
+
+Ensure that you have the following installed locally:
+- [Node.js](https://nodejs.org/) (latest LTS version recommended)
+
+### Example Application
+The following example uses a basic Express application in Node.js
+
+### Create and launch an HTTP Server
+
+To begin, set up an environment in a new directory called nodejs-simple. Within that directory, execute the following commands:
+
+```bash
+npm init -y
+```
+
+```bash
+npm install express
+```
+
+In the same directory, Ccreate a file named app.js and add the following code:
+
+```javascript
+const express = require('express');
+
+const PORT = parseInt(process.env.PORT || '8080');
+const app = express();
+
+function getRandomNumber(min, max) {
+ return Math.floor(Math.random() * (max - min + 1)) + min;
+}
+
+app.get('/rolldice', (req, res) => {
+ res.send(getRandomNumber(1, 6).toString());
+});
+
+app.listen(PORT, () => {
+ console.log(`Listening for requests on http://localhost:${PORT}`);
+});
+
+```
+
+Run the application with the following command:
+
+```bash
+node app.js
+```
+
+Open http://localhost:8080/rolldice in your web browser to ensure it is working.
+
+
+### Instrumentation
+
+Next, we’ll install the necessary packages for logging telemetry data to Logz.io using OpenTelemetry.
+
+
+1. Add the packages
+ ```bash
+ npm install winston axios
+ ```
+
+2. Create a custom Logz.io transport for Winston
+
+ Create a file named logzio-transport.js and add the following code:
+
+ ```javascript
+ const Transport = require('winston-transport');
+ const axios = require('axios');
+
+ class LogzIoTransport extends Transport {
+ constructor(opts) {
+ super(opts);
+ this.endpoint = opts.endpoint;
+ this.token = opts.token;
+ this.serviceName = opts.serviceName;
+ }
+
+ log(info, callback) {
+ setImmediate(() => this.emit('logged', info));
+
+ const logEntry = {
+ message: info.message,
+ level: info.level,
+ service: this.serviceName,
+ ...info.meta,
+ };
+
+ axios.post(this.endpoint, logEntry, {
+ headers: {
+ 'Authorization': `Bearer ${this.token}`,
+ 'Content-Type': 'application/json',
+ },
+ })
+ .then(() => callback())
+ .catch(err => {
+ console.error('Error sending log to Logz.io:', err);
+ callback();
+ });
+ }
+ }
+
+ module.exports = LogzIoTransport;
+
+ ```
+
+3. Set up the logging configuration:
+
+ In your app.js, replace the content with the following:
+
+ ```javascript
+ const express = require('express');
+ const winston = require('winston');
+ const LogzIoTransport = require('./logzio-transport');
+
+ const PORT = process.env.PORT || 8080;
+ const app = express();
+
+ const logger = winston.createLogger({
+ level: 'info',
+ format: winston.format.json(),
+ transports: [
+ new LogzIoTransport({
+ endpoint: 'https://listener.logz.io:8071',
+ token: '',
+ serviceName: 'nodejs-roll-dice',
+ }),
+ ],
+ });
+
+ function getRandomNumber(min, max) {
+ return Math.floor(Math.random() * (max - min + 1)) + min;
+ }
+
+ app.get('/rolldice', (req, res) => {
+ const result = getRandomNumber(1, 6);
+ logger.info(`Rolled dice: ${result}`);
+ res.send(result.toString());
+ });
+
+ app.listen(PORT, () => {
+ logger.info(`Listening for requests on http://localhost:${PORT}`);
+ console.log(`Listening for requests on http://localhost:${PORT}`);
+ });
+ ```
+
+4. Run your **application** once again:
+
+ ```bash
+ node app.js
+ ```
+ Note the output from the dotnet run.
+
+4. From another terminal, send a request using curl:
+
+ ```
+ curl localhost:8080/rolldice
+ ```
+5. After about 30 sec, stop the server process.
+
+At this point, you should see log output from the server and client on your Logz.io account.
+
+
+
+
## Metrics
These examples use the [OpenTelemetry JS SDK](https://github.com/open-telemetry/opentelemetry-js) and are based on the [OpenTelemetry exporter collector proto](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-exporter-collector-proto).
From 133fa1ebb317bc42cb4ad08c7c757c97852b57d5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9Cnico-shishkin=E2=80=9D?=
<“nicoshishkinatlogz@outlook.com”>
Date: Sun, 18 Aug 2024 21:58:05 +0100
Subject: [PATCH 03/13] Python docs
---
docs/shipping/Code/python.md | 185 +++++++++++++++++++++++++++++++++++
1 file changed, 185 insertions(+)
diff --git a/docs/shipping/Code/python.md b/docs/shipping/Code/python.md
index c077f8f8..dc78526e 100644
--- a/docs/shipping/Code/python.md
+++ b/docs/shipping/Code/python.md
@@ -17,6 +17,12 @@ drop_filter: []
## Logs
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+
+
+
:::note
[Project's GitHub repo](https://github.com/logzio/logzio-python-handler/)
:::
@@ -311,6 +317,185 @@ logger.addFilter(TruncationLoggerFilter())
The default limit is 32,700, but you can adjust this value as required.
+
+
+
+### Prerequisites
+
+Ensure that you have the following installed locally:
+
+* Python 3.7 or newer
+* pip (Python package installer)
+
+### Example Application
+
+The following example uses a basic Flask application.
+
+
+### Create and launch an HTTP Server
+
+To begin, set up an environment in a new directory called `otel-getting-started`. Within that directory, follow these steps:
+
+
+1. Create and activate a virtual environment:
+
+ ```bash
+ mkdir otel-getting-started
+ cd otel-getting-started
+ python3 -m venv venv
+ source venv/bin/activate
+ ```
+
+2. Install Flask and OpenTelemetry dependencies:
+
+ ```bash
+ pip install flask opentelemetry-api opentelemetry-sdk opentelemetry-exporter-otlp
+ ```
+
+3. Create a Flask application in a file named app.py and add the following code:
+
+ ```python
+ from flask import Flask
+ import random
+ import logging
+
+ # Basic Flask application setup
+ app = Flask(__name__)
+
+ # Set up basic logging to console
+ logging.basicConfig(level=logging.INFO)
+ logger = logging.getLogger("app")
+
+ @app.route("/rolldice/", methods=["GET"])
+ @app.route("/rolldice/", methods=["GET"])
+ def handle_roll_dice(player=None):
+ result = roll_dice()
+
+ if player:
+ logger.info(f"{player} is rolling the dice: {result}")
+ else:
+ logger.info(f"Anonymous player is rolling the dice: {result}")
+
+ return str(result)
+
+ def roll_dice():
+ return random.randint(1, 6)
+
+ if __name__ == "__main__":
+ app.run(host="0.0.0.0", port=8080)
+ ```
+
+
+4. Run the application:
+
+ ``` bash
+ python app.py
+ ```
+
+Open http://localhost:8080/rolldice in your web browser to ensure it is working.
+
+
+### Instrumentation
+
+Next, we'll configure the OpenTelemetry logging exporter to send logs to Logz.io.
+
+1. Install OpenTelemetry dependencies:
+
+ ```bash
+ pip install opentelemetry-api opentelemetry-sdk opentelemetry-exporter-otlp
+ ```
+
+2. Update the Flask Application to Include OpenTelemetry:
+
+ Modify the existing app.py file to include OpenTelemetry logging:
+
+ ```python
+ from flask import Flask
+ import random
+ import logging
+
+ from opentelemetry._logs import set_logger_provider
+ from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter
+ from opentelemetry.sdk.resources import Resource
+ from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
+ from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
+
+ # Configuration
+ service_name = "roll-dice"
+ logzio_endpoint = "https://otlp-listener.logz.io/v1/logs"
+ logzio_token = "<>"
+
+ # Set up OpenTelemetry resources
+ resource = Resource.create({"service.name": service_name})
+
+ # Set up Logger Provider and OTLP Log Exporter (HTTP/JSON)
+ logger_provider = LoggerProvider(resource=resource)
+ set_logger_provider(logger_provider)
+ log_exporter = OTLPLogExporter(
+ endpoint=logzio_endpoint,
+ headers={"Authorization": f"Bearer {logzio_token}"}
+ )
+ logger_provider.add_log_record_processor(BatchLogRecordProcessor(log_exporter))
+
+ # Set up a specific logger for the application
+ logger = logging.getLogger("app")
+ logger.setLevel(logging.INFO)
+
+ # Attach OTLP handler to the specific logger
+ otlp_handler = LoggingHandler(logger_provider=logger_provider)
+ logger.addHandler(otlp_handler)
+
+ # Attach a StreamHandler to log to the console
+ console_handler = logging.StreamHandler()
+ console_handler.setLevel(logging.INFO)
+ formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+ console_handler.setFormatter(formatter)
+ logger.addHandler(console_handler)
+
+ # Flask application setup
+ app = Flask(__name__)
+
+ @app.route("/rolldice/", methods=["GET"])
+ @app.route("/rolldice/", methods=["GET"])
+ def handle_roll_dice(player=None):
+ result = roll_dice()
+
+ if player:
+ logger.info(f"{player} is rolling the dice: {result}")
+ else:
+ logger.info(f"Anonymous player is rolling the dice: {result}")
+
+ return str(result)
+
+ def roll_dice():
+ return random.randint(1, 6)
+
+ if __name__ == "__main__":
+ app.run(host="0.0.0.0", port=8080)
+ ```
+
+ {@include: ../../_include/log-shipping/log-shipping-token.md}
+
+
+3. Run your **application** once again:
+
+ ```bash
+ python app.py
+ ```
+
+4. From another terminal, send a request using curl:
+
+ ```bash
+ curl localhost:8080/rolldice
+ ```
+5. After about 30 sec, stop the server process.
+
+At this point, you should see log output from the server and client on your Logz.io account.
+
+
+
+
+
## Metrics
From 1b1a2c23413a80e820d5c7016d0549657f06c85c Mon Sep 17 00:00:00 2001
From: Simplychee
Date: Wed, 21 Aug 2024 15:15:02 +0300
Subject: [PATCH 04/13] new explore images
---
docs/user-guide/explore/new-explore.md | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/docs/user-guide/explore/new-explore.md b/docs/user-guide/explore/new-explore.md
index e02080b1..d98df307 100644
--- a/docs/user-guide/explore/new-explore.md
+++ b/docs/user-guide/explore/new-explore.md
@@ -9,7 +9,7 @@ slug: /user-guide/new-explore/
Explore provides a unified dashboard for monitoring your data, offering a quick and efficient way to identify and debug issues. Designed for investigating and analyzing large data volumes, Explore allows you to use filters, queries, and searches to pinpoint and delve into problems effortlessly.
-
+
### Simple Search / Advanced (Lucene)
@@ -20,11 +20,13 @@ Click on the dropdown menu to switch between Simple Search and Advanced Search,
Build your query by selecting fields, parameters, and conditions. To add a value that doesn't appear in your logs, type its name and click on the + sign. You can also add free text to your search, which will convert it into a Lucene query.
-
+
* **Advanced (Lucene)**: Use advanced text querying for log searches. You can search for free text by typing the text string you want to find; for example, error will return all words containing this string, and using quotation marks, "error", will return only the specific word you're searching for.
-
+
+
+
### Filters
@@ -36,7 +38,7 @@ All visible fields appear on the left side, including exceptions (if any) and sp
You can pin up to three custom fields by hovering over them and clicking the star icon.
-
+
### Graph View
@@ -45,7 +47,7 @@ Visualize trends over time and group data based on your investigations. Hover ov
You can enlarge or reduce the size of the graph by clicking the arrow button at the top right.
-
+
### Exceptions
From a46cd621382304b2b69a09d20ae4bfe0f48fc77d Mon Sep 17 00:00:00 2001
From: Simplychee
Date: Wed, 21 Aug 2024 17:28:02 +0300
Subject: [PATCH 05/13] edits
---
docs/user-guide/explore/new-explore.md | 12 ++++++------
docs/user-guide/k8s-360/overview.md | 6 +++++-
2 files changed, 11 insertions(+), 7 deletions(-)
diff --git a/docs/user-guide/explore/new-explore.md b/docs/user-guide/explore/new-explore.md
index d98df307..f225c625 100644
--- a/docs/user-guide/explore/new-explore.md
+++ b/docs/user-guide/explore/new-explore.md
@@ -66,16 +66,16 @@ To select a custom time frame, click the time element and choose the period rele
### Observability IQ Assistant
-Click the ✨ Observability IQ button to activate Observability IQ Assistant, an AI-powered, chat-based interface that lets you engage in a dynamic conversation with your data. Use one of the pre-configured prompts or type your own question to get real-time insights about your metrics, anomalies, trends, and the overall health of your environment.
+Click the **AI Assistant** button to activate [Observability IQ Assistant](/docs/user-guide/observability/assistantiq), an AI-powered, chat-based interface that lets you engage in a dynamic conversation with your data. Use one of the pre-configured prompts or type your own question to get real-time insights about your metrics, anomalies, trends, and the overall health of your environment.
-
+
### Group By
The default graph view is set to group by all fields, and you can choose specific fields to focus on from the dropdown menu.
-
+
@@ -84,7 +84,7 @@ The default graph view is set to group by all fields, and you can choose specifi
Click the 1L button to change the table view. Selecting **1 Line** provides a compact view, **2 Lines** displays two lines from the logs, and **Expanded** offers a full log view, presenting all relevant data for easier viewing.
-
+
### Create Alert, Copy Link, Export CSV
@@ -94,7 +94,7 @@ The ⋮ menu offers additional options for Explore, including:
* **Copy Link**: Generates a URL with your current view, which you can share with team members. You need to be logged in to Logz.io to view it
* **Export CSV**: Exports up to 50,000 logs to a CSV file, including the timestamp and log message
-
+
### Logs Table
@@ -104,4 +104,4 @@ Expand each log to view additional details, see the log in JSON format, and add
In the top right corner, choose to view a single log in a new window, view surrounding logs for context, and share the URL of the specific log you're viewing.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/user-guide/k8s-360/overview.md b/docs/user-guide/k8s-360/overview.md
index 0c493cfe..b7c84af9 100644
--- a/docs/user-guide/k8s-360/overview.md
+++ b/docs/user-guide/k8s-360/overview.md
@@ -39,7 +39,7 @@ You can dive deeper into each card by clicking on it and opening the **[Quick vi
You can change and adjust Kubernetes 360 application to match your monitoring and troubleshooting needs. To help you get started, we'll break down the different options, how you can access them, and how they can help you and your team.
-
+
@@ -50,6 +50,10 @@ First, choose the environment you'd like to view. Environments with many users,
Next, choose whether to view the environment's clusters, nodes, or both. Each dropdown menu includes all clusters and nodes in the chosen Kubernetes account, and you can use the search bar to find and add nodes to your view easily.
+Observability IQ Assistant
+
+Click the **AI Assistant** button to activate [Observability IQ Assistant](/docs/user-guide/observability/assistantiq), an AI-powered, chat-based interface that lets you engage in a dynamic conversation with your data. Use one of the pre-configured prompts or type your own question to get real-time insights about your metrics, anomalies, trends, and the overall health of your environment.
+
View
You can switch your view to filter by the following resources: **Node**, **Pod**, **Deployment**, **Daemonset**, **Statefulset**, or **Job**.
From 387aa719b39419f3815d8ffc0af7c350756e3f1d Mon Sep 17 00:00:00 2001
From: Simplychee
Date: Thu, 22 Aug 2024 13:18:00 +0300
Subject: [PATCH 06/13] edits
---
docs/user-guide/observability/faq.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/user-guide/observability/faq.md b/docs/user-guide/observability/faq.md
index bdb69a91..a3296c2a 100644
--- a/docs/user-guide/observability/faq.md
+++ b/docs/user-guide/observability/faq.md
@@ -51,7 +51,7 @@ The model is hosted within the same region in which your Logz.io data is hosted.
### Can account admins see my queries and chat history?
-No. Account admins or any other users within your organization cannot view or access any queries or chat history from the Observability IQ Assistant. Logz.io does not retain your query or chat history and is deleted after the session ends.
+No. Account admins or any other users within your organization cannot view or access any queries or chat history from the Observability IQ Assistant.
### Do you use my data to train the AI model?
From 51359aa1b8c37f58b361d7fce32a93a5dab6d3f0 Mon Sep 17 00:00:00 2001
From: Simplychee
Date: Thu, 22 Aug 2024 14:46:14 +0300
Subject: [PATCH 07/13] yaml
---
docs/user-guide/k8s-360/overview.md | 95 ++++++++++++++---------------
1 file changed, 47 insertions(+), 48 deletions(-)
diff --git a/docs/user-guide/k8s-360/overview.md b/docs/user-guide/k8s-360/overview.md
index 0c493cfe..7d375a30 100644
--- a/docs/user-guide/k8s-360/overview.md
+++ b/docs/user-guide/k8s-360/overview.md
@@ -14,7 +14,7 @@ Kubernetes 360 lets R&D and engineering teams monitor and troubleshoot applicati
The platform utilizes Kubernetes' numerous advantages for R&D and dev teams, allowing you to monitor application SLOs in a simple, efficient, and actionable manner. Kubernetes 360 offers flexibility and visibility while providing service discovery, balancing load, and allowing developer autonomy and business agility.
-
+
To activate your Kubernetes 360 dashboard, connect your Kubernetes data quickly and easily through Logz.io's **[Telemetry Collector](https://app.logz.io/#/dashboard/integrations/collectors?tags=Quick%20Setup)**.
@@ -25,21 +25,21 @@ Once everything is up and running, you can use your Kubernetes 360 application.
-## Kubernetes 360 overview
+
+
-You can dive deeper into each card by clicking on it and opening the **[Quick view](#quick-view)** menu.
+You can dive deeper into each card by clicking on it and opening the **[Quick view](#quick-view)** menu.-->
-## Customize your application
+## Kubernetes 360 overview
-You can change and adjust Kubernetes 360 application to match your monitoring and troubleshooting needs. To help you get started, we'll break down the different options, how you can access them, and how they can help you and your team.
+You can use Kubernetes 360 to suit your monitoring and troubleshooting needs. To help you get started, we'll break down the different options, how you can access them, and how they can help you and your team.
-
+
@@ -48,13 +48,22 @@ You can change and adjust Kubernetes 360 application to match your monitoring an
First, choose the environment you'd like to view. Environments with many users, teams, or projects use a namespace to bundle relevant clusters and nodes. This filter allows you to focus on all elements inside a specific namespace.
-Next, choose whether to view the environment's clusters, nodes, or both. Each dropdown menu includes all clusters and nodes in the chosen Kubernetes account, and you can use the search bar to find and add nodes to your view easily.
+Next, choose whether to view the environment's clusters, namespaces, or deployments. Each dropdown menu includes all clusters and nodes in the chosen Kubernetes account, and you can use the search bar to find and add nodes to your view easily.
+
+
+
+
+Observability IQ Assistant
+
+Click the **AI Assistant** button to activate [Observability IQ Assistant](/docs/user-guide/observability/assistantiq), an AI-powered, chat-based interface that lets you engage in a dynamic conversation with your data. Use one of the pre-configured prompts or type your own question to get real-time insights about your metrics, anomalies, trends, and the overall health of your environment.
+
+
View
You can switch your view to filter by the following resources: **Node**, **Pod**, **Deployment**, **Daemonset**, **Statefulset**, or **Job**.
-
+
In addition, you can also switch between the **Map** and **List** views, according to your monitoring needs. Note that the Pod view can only be seen as a list.
@@ -91,21 +100,21 @@ By default, Kubernetes 360 provides an overview of your current environment. Use
Clicking on one of the cards or rows opens the quick view menu. This menu provides additional information about each element, allowing you to investigate and understand what’s happening inside your Kubernetes environment.
-For each available view - Deployment, Pod, Node, Dameonset, Statefulset, and Job - you can access the quick view to gain more information, such as:
+For each available view - Deployment, Pod, Node, Dameonset, Statefulset, and Job - you can access the quick view to gain more information, such as:
* **Cluster** - The cluster associated with the chosen view.
* **Namespace** - The unique namespace.
* **Status** - Indicates whether that condition is applicable, with possible values **True**, **False**, or **Unknown**.
-* **CPU** - Amount of CPU used. If the CPU is not capped, you'll see an indicator stating **no limit**.
+* **CPU** - Amount of CPU used. You'll see an indicator stating **no limit** if the CPU is not capped.
* **Memory** - An average calculation of how much memory is in use.
* **Uptime** - The duration of how long the chosen view has been running.
* **Security risks** - The number of potential security risks.
-And more.
+And of course, activate Observability IQ Assistant to open the AI-powered, chat-based interface to engage and query your data further.
-
+
-Each view lets you dive deeper into the data by using the links at the top of the quick view. Click on **See Metrics**, **See Traces**, or **See Logs** to navigate directly to the relevant view.
+Click on **See Metrics**, **See Traces**, or **See Logs** to navigate to each dashboard's relevant view.
### Quick view tabs
@@ -113,7 +122,7 @@ Each view lets you dive deeper into the data by using the links at the top of th
To enrich your existing and newly sent data, use the [Telemetry Collector](https://app.logz.io/#/dashboard/integrations/collectors?tags=Quick%20Setup) to configure and send data quickly.
:::
-Each quick view includes several tabs that provide additional information you can act on. For each tab, you can change the time frame chosen by clicking on the date bar at the top.
+Each quick view includes several tabs that provide additional information you can act on. You can choose the time frame for each tab by clicking on the date bar at the top.
Pods tab
@@ -123,13 +132,13 @@ The Pods tab provides a list of all pods related to this node. The table include
Logs tab
-In the Logs tab you can view the time, log level, and message for each log line. You can search for specific logs using the search bar, which supports free text and Lucene queries.
+The Logs tab shows each log line's time, log level, and message. The search bar supports free text and Lucene queries so that you can search for specific logs.
Metrics tab
-The **Metrics** tab presents useful data in graph form. These graphs provides a view of Replicas Over Time, CPU Usage (cores) per pod, Memory Usage Per Pod, CPU Usage, Requests and Limits (Cores), Memory Usage, Requests and Limits, and Received & Transmitted Bytes.
+The **Metrics** tab presents useful data in graph form. These graphs provide a view of Replicas Over Time, CPU Usage (cores) per pod, Memory Usage Per Pod, CPU Usage, Requests and Limits (Cores), Memory Usage, Requests and Limits, and Received & Transmitted Bytes.
@@ -139,14 +148,15 @@ The **Traces** tab includes all of the spans in this deployment, including the f
* Time
* Trace ID
-* The Service related to the span
-* Which Operation ran
-* The Duration of the run, represented in milliseconds
+* The service related to the span
+* Which operation ran
+* The duration of the run, represented in milliseconds
* Status code indicating whether a specific HTTP request has been successfully completed
- Trace quickview
+
+ Trace quick view
Click on one of the **Trace ID** items to open the Trace quick view. This view includes additional data such as Trace ID, group name, timestamp marking the beginning of a trace being monitored, and the originating service.
@@ -158,16 +168,24 @@ The link icon next to each operation and service opens the service overview for
+YAML tab
+
+You can view each node's YAML configuration, allowing easier troubleshooting and configuration verification.
+
+Open the node you want to investigate and click the YAML tab. With direct access to YAML files, you can quickly understand and audit the underlying settings and setups of Kubernetes deployments, ensuring configurations align with operational requirements and best practices.
+
+
-### Investigate through quick view
-See Metrics
+## Investigate through quick view
+
+See Metrics
You can easily investigate the different issues you might encounter.
Each quick view menu contains the **View Metrics** button, allowing you to view the relevant information in a Grafana application. This can provide a focused overview of the chosen element, allowing you to pinpoint what happened and when it started quickly.
-See Logs
+See Logs
Node and pod views include the **See Logs** button, which opens an OpenSearch Dashboards screen with the relevant query to display the log information.
@@ -178,25 +196,25 @@ Click on **Add filter** at the top of the screen. The fields vary according to y
Next, choose the operator. For example, you can select **exists** to view all related logs.
-Open Livetail
+Open Livetail
Node and pod views include the **Open Livetail** button, which opens Logz.io's Livetail filtered with the selected Kubernetes host. Live tail gives you a live view of your logs as they come into Logz.io, allowing you to view and troubleshoot in real time.
-Open Traces
+Open Traces
The Deployment view includes the **See Traces** button, which opens Jaeger with the relevant data needed to deep dive into it. Gain a system-wide view of your distributed architecture, detect failed or high latency requests, and quickly drill into end-to-end call sequences of selected requests of intercommunicating microservices.
## Track Deployment Data
-You can enrich your Kubernetes 360 graphs by adding an indication of recent deployments, helping you determine if a deployment has increased response times for end-users, altered your application's memory/CPU footprint, or introduced any other performance-related changes.
+You can enrich your Kubernetes 360 graphs by adding an indication of recent deployments. This will help you determine whether a deployment has increased end-user response times, altered your application's memory/CPU footprint, or introduced any other performance-related changes.
To enable deployment tracking ability, run the [**Telemetry Collector**](https://app.logz.io/#/dashboard/integrations/collectors?tags=Quick%20Setup) on your Kubernetes clusters. You can also activate this process **manually** by installing [Logz.io Kubernetes events Helm chart](https://app.logz.io/#/dashboard/integrations/Kubernetes:~:text=user%20guide.-,Send%20your%20deploy%20events%20logs,-This%20integration%20sends).
Once enabled, the graphs will include a deployment marker, marked by a dotted vertical line.
-You can view additional deployment data by clicking on the line. This data includes the deployment time, the associated service and environment, and a quick link to view the commit in your logs.
+Clicking on the line allows you to view additional deployment data. This data includes the deployment time, the associated service and environment, and a quick link to view the commit in your logs.
Click **Go to commit** to access and view your own code related to this deployment, allowing you to probe deeper into the relevant data.
@@ -209,25 +227,6 @@ To activate the **Go to Commit** button, go to **your app or service** and add t
-
-
-
-
-
-
-
## Additional information
### Calculating Log error rate
From bbb263eaf42fc0ee1bb8ee1f3f6e06b1846623be Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9Cnico-shishkin=E2=80=9D?=
<“nicoshishkinatlogz@outlook.com”>
Date: Thu, 22 Aug 2024 14:29:23 +0100
Subject: [PATCH 08/13] Otel SDKs
---
docs/shipping/Code/dotnet.md | 123 ++++++++-------
docs/shipping/Code/go.md | 274 ++++++++++++++++++++++++++++++++++
docs/shipping/Code/node-js.md | 84 ++++++-----
docs/shipping/Code/python.md | 30 +++-
4 files changed, 407 insertions(+), 104 deletions(-)
diff --git a/docs/shipping/Code/dotnet.md b/docs/shipping/Code/dotnet.md
index 801eeb2a..52b29544 100644
--- a/docs/shipping/Code/dotnet.md
+++ b/docs/shipping/Code/dotnet.md
@@ -1192,14 +1192,14 @@ The following example uses a basic [Minimal API with ASP.NET Core](https://learn
### Create and launch an HTTP Server
-To begin, set up an environment in a new directory called `dotnet-simple`. Within that directory, execute following command:
+1. Set up an environment in a new directory called `dotnet-simple`. Within that directory, execute following command:
-```
+```bash
dotnet new web
```
-In the same directory, replace the content of Program.cs with the following code:
+2. In the same directory, replace the content of `Program.cs` with the following code:
-```
+```csharp
using System.Globalization;
using Microsoft.AspNetCore.Mvc;
@@ -1234,7 +1234,7 @@ app.Run();
```
-In the Properties subdirectory, replace the content of launchSettings.json with the following:
+3. In the `Properties` subdirectory, replace the content of `launchSettings.json` with the following:
```
{
@@ -1254,7 +1254,7 @@ In the Properties subdirectory, replace the content of launchSettings.json with
```
-Build and run the application with the following command, then open http://localhost:8080/rolldice in your web browser to ensure it is working.
+4. Build and run the application with the following command, then open http://localhost:8080/rolldice in your web browser to ensure it is working.
```
dotnet build
@@ -1262,67 +1262,74 @@ dotnet run
```
### Instrumentation
-Next we’ll install the instrumentation [NuGet packages from OpenTelemetry](https://www.nuget.org/profiles/OpenTelemetry) that will generate the telemetry, and set them up.
+Next, we'll configure the OpenTelemetry logging exporter to send logs to Logz.io via the OTLP listener.
+
+This configuration is designed to send logs to your Logz.io account via the OpenTelemetry Protocol (OTLP) listener. You need to specify your Logz.io token and configure the listener endpoint to match the correct region. By default, the endpoint is `https://otlp-listener.logz.io/v1/logs`, but it should be adjusted based on your region. You can find more details on the regional configurations in the [Hosting Regions Documentation](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/#available-regions).
+
+:::note
+Ensure that you include the `user-agent` header in the format: `"user-agent=logzio-python-logs-otlp"`.
+:::
1. Add the packages
- ```
- dotnet add package OpenTelemetry.Extensions.Hosting
- dotnet add package OpenTelemetry.Instrumentation.AspNetCore
- dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol
- ```
-
-2. Setup the OpenTelemetry code
-
- In Program.cs, replace the following lines:
-
- ```
- var builder = WebApplication.CreateBuilder(args);
- var app = builder.Build();
- ```
- With:
- ```
- using OpenTelemetry;
- using OpenTelemetry.Logs;
- using OpenTelemetry.Resources;
- using OpenTelemetry.Exporter;
-
- var builder = WebApplication.CreateBuilder(args);
-
- const string serviceName = "roll-dice";
- const string logzioEndpoint = "https://otlp-listener.logz.io/v1/logs";
- const string logzioToken = "";
-
- builder.Logging.AddOpenTelemetry(options =>
- {
- options
- .SetResourceBuilder(
- ResourceBuilder.CreateDefault()
- .AddService(serviceName))
- .AddOtlpExporter(otlpOptions =>
- {
- otlpOptions.Endpoint = new Uri(logzioEndpoint);
- otlpOptions.Headers = $"Authorization=Bearer {logzioToken}, user-agent=logzio-dotnet-logs";
- otlpOptions.Protocol = OtlpExportProtocol.HttpProtobuf;
- });
- });
-
- var app = builder.Build();
- ```
+
+ ```bash
+ dotnet add package OpenTelemetry.Extensions.Hosting
+ dotnet add package OpenTelemetry.Instrumentation.AspNetCore
+ dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol
+ ```
+
+2. Setup the OpenTelemetry code in `Program.cs`, by replacing the following lines:
+
+ ```csharp
+ var builder = WebApplication.CreateBuilder(args);
+ var app = builder.Build();
+ ```
+
+ With:
+
+
+ ```csharp
+ using OpenTelemetry;
+ using OpenTelemetry.Logs;
+ using OpenTelemetry.Resources;
+ using OpenTelemetry.Exporter;
+ var builder = WebApplication.CreateBuilder(args);
+ const string serviceName = "roll-dice";
+ const string logzioEndpoint = "https://otlp-listener.logz.io/v1/logs";
+ const string logzioToken = "";
+ builder.Logging.AddOpenTelemetry(options =>
+ {
+ options
+ .SetResourceBuilder(
+ ResourceBuilder.CreateDefault()
+ .AddService(serviceName))
+ .AddOtlpExporter(otlpOptions =>
+ {
+ otlpOptions.Endpoint = new Uri(logzioEndpoint);
+ otlpOptions.Headers = $"Authorization=Bearer {logzioToken}, user-agent=logzio-dotnet-logs";
+ otlpOptions.Protocol = OtlpExportProtocol.HttpProtobuf;
+ });
+ });
+ var app = builder.Build();
+ ```
+
+ {@include: ../../_include/log-shipping/log-shipping-token.md}
+
3. Run your **application** once again:
- ```
- dotnet run
- ```
- Note the output from the dotnet run.
+ ```bash
+ dotnet run
+ ```
4. From another terminal, send a request using curl:
- ```
- curl localhost:8080/rolldice
- ```
+ ```bash
+ curl localhost:8080/rolldice
+ ```
+
5. After about 30 sec, stop the server process.
-At this point, you should see log output from the server and client on your Logzio account.
+At this point, you should see log output from the server and client on your Logz.io account.
diff --git a/docs/shipping/Code/go.md b/docs/shipping/Code/go.md
index 0eb27d35..d8ae69e2 100644
--- a/docs/shipping/Code/go.md
+++ b/docs/shipping/Code/go.md
@@ -21,6 +21,12 @@ If your code is running inside Kubernetes the best practice will be to use our [
## Logs
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+
+
+
:::note
[Project's GitHub repo](https://github.com/logzio/logzio-go/)
:::
@@ -383,6 +389,274 @@ Install the pre-built dashboard to enhance the observability of your metrics.
{@include: ../../_include/metric-shipping/generic-dashboard.html}
+
+
+
+### Prerequisites
+
+Ensure that you have the following installed locally:
+
+* Go 1.21 or newer
+
+### Example Application
+
+The following example uses a basic net/http application in Go. This guide will help you set up the environment, create the application, and configure it to send logs to Logz.io using OpenTelemetry.
+
+
+
+### Create and launch an HTTP Server
+
+1. Create a new directory for your Go project and initialize the Go module:
+
+ ```bash
+ mkdir otel-getting-started
+ cd otel-getting-started
+ go mod init otel-getting-started
+ ```
+
+2. Create and activate a virtual environment:
+
+ ```bash
+ mkdir otel-getting-started
+ cd otel-getting-started
+ python3 -m venv venv
+ source venv/bin/activate
+ ```
+
+3. Create a file named main.go and add the following code to set up a simple HTTP server:
+
+ ```go
+ package main
+
+ import (
+ "io"
+ "math/rand"
+ "net/http"
+ "strconv"
+ "strings"
+
+ "go.opentelemetry.io/otel/attribute"
+ "go.opentelemetry.io/otel/metric"
+ )
+
+ func rolldice(w http.ResponseWriter, r *http.Request) {
+ ctx, span := tracer.Start(r.Context(), "roll")
+ defer span.End()
+
+ // Extract the player's name from a query parameter or other parts of the request
+ path := r.URL.Path
+ segments := strings.Split(path, "/")
+ playerName := "Anonymous" // Default name if not specified
+
+ if len(segments) > 2 && segments[2] != "" {
+ playerName = segments[2]
+ }
+
+ roll := 1 + rand.Intn(6)
+
+ if playerName == "Anonymous" {
+ logger.InfoContext(ctx, "Anonymous player is rolling the dice", "result", roll)
+ } else {
+ logger.InfoContext(ctx, playerName+" is rolling the dice", "result", roll)
+ }
+
+ rollValueAttr := attribute.Int("roll.value", roll)
+ span.SetAttributes(rollValueAttr)
+ rollCnt.Add(ctx, 1, metric.WithAttributes(rollValueAttr))
+
+ resp := strconv.Itoa(roll) + "\n"
+ if _, err := io.WriteString(w, resp); err != nil {
+ logger.ErrorContext(ctx, "Write failed", "error", err)
+ }
+ }
+
+ func main() {
+ http.HandleFunc("/rolldice", rolldice)
+ http.ListenAndServe(":8080", nil)
+ }
+
+ ```
+
+4. Run the application:
+
+ ``` bash
+ go run main.go
+ ```
+
+Open http://localhost:8080/rolldice in your web browser to ensure it is working.
+
+
+### Instrumentation
+
+Next, we'll configure the OpenTelemetry logging exporter to send logs to Logz.io via the OTLP listener.
+
+This configuration is designed to send logs to your Logz.io account via the OpenTelemetry Protocol (OTLP) listener. You need to specify your Logz.io token and configure the listener endpoint to match the correct region. By default, the endpoint is `https://otlp-listener.logz.io/v1/logs`, but it should be adjusted based on your region. You can find more details on the regional configurations in the [Hosting Regions Documentation](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/#available-regions).
+
+:::note
+Ensure that you include the `user-agent` header in the format: `"user-agent=logzio-python-logs-otlp"`.
+:::
+
+1. Install OpenTelemetry dependencies:
+
+ ```bash
+ go get go.opentelemetry.io/otel
+ go get go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp
+ go get go.opentelemetry.io/otel/exporters/stdout/stdoutlog
+ go get go.opentelemetry.io/otel/exporters/stdout/stdoutmetric
+ ```
+
+2. Create a new file named `otel.go` and add the following code to set up OpenTelemetry logging:
+
+
+ ```go
+ package main
+ import (
+ "context"
+ "errors"
+ "fmt"
+ "time"
+
+ "go.opentelemetry.io/otel"
+ "go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp"
+ "go.opentelemetry.io/otel/exporters/stdout/stdoutlog"
+ "go.opentelemetry.io/otel/exporters/stdout/stdoutmetric"
+ "go.opentelemetry.io/otel/log/global"
+ "go.opentelemetry.io/otel/propagation"
+ "go.opentelemetry.io/otel/sdk/log"
+ "go.opentelemetry.io/otel/sdk/metric"
+ "go.opentelemetry.io/otel/sdk/trace"
+ )
+
+ func setupOTelSDK(ctx context.Context) (shutdown func(context.Context) error, err error) {
+ var shutdownFuncs []func(context.Context) error
+
+ shutdown = func(ctx context.Context) error {
+ var err error
+ for _, fn := range shutdownFuncs {
+ err = errors.Join(err, fn(ctx))
+ }
+ shutdownFuncs = nil
+ return err
+ }
+
+ handleErr := func(inErr error) {
+ err = errors.Join(inErr, shutdown(ctx))
+ }
+
+ prop := newPropagator()
+ otel.SetTextMapPropagator(prop)
+
+ tracerProvider, err := newTraceProvider()
+ if err != nil {
+ handleErr(err)
+ return
+ }
+ shutdownFuncs = append(shutdownFuncs, tracerProvider.Shutdown)
+ otel.SetTracerProvider(tracerProvider)
+
+ meterProvider, err := newMeterProvider()
+ if err != nil {
+ handleErr(err)
+ return
+ }
+ shutdownFuncs = append(shutdownFuncs, meterProvider.Shutdown)
+ otel.SetMeterProvider(meterProvider)
+
+ loggerProvider, err := newLoggerProvider()
+ if err != nil {
+ handleErr(err)
+ return
+ }
+ shutdownFuncs = append(shutdownFuncs, loggerProvider.Shutdown)
+ global.SetLoggerProvider(loggerProvider)
+
+ return
+ }
+
+ func newPropagator() propagation.TextMapPropagator {
+ return propagation.NewCompositeTextMapPropagator(
+ propagation.TraceContext{},
+ propagation.Baggage{},
+ )
+ }
+
+ func newTraceProvider() (*trace.TracerProvider, error) {
+ traceExporter, err := stdouttrace.New(
+ stdouttrace.WithPrettyPrint())
+ if err != nil {
+ return nil, err
+ }
+
+ traceProvider := trace.NewTracerProvider(
+ trace.WithBatcher(traceExporter,
+ trace.WithBatchTimeout(time.Second)),
+ )
+ return traceProvider, nil
+ }
+
+ func newMeterProvider() (*metric.MeterProvider, error) {
+ metricExporter, err := stdoutmetric.New()
+ if err != nil {
+ return nil, err
+ }
+
+ meterProvider := metric.NewMeterProvider(
+ metric.WithReader(metric.NewPeriodicReader(metricExporter,
+ metric.WithInterval(3*time.Second))),
+ )
+ return meterProvider, nil
+ }
+
+ func newLoggerProvider() (*log.LoggerProvider, error) {
+ stdoutExporter, err := stdoutlog.New(stdoutlog.WithPrettyPrint())
+ if err != nil {
+ return nil, fmt.Errorf("failed to create stdout exporter: %w", err)
+ }
+
+ httpExporter, err := otlploghttp.New(context.Background(),
+ otlploghttp.WithEndpoint("otlp-listener.logz.io"),
+ otlploghttp.WithHeaders(map[string]string{
+ "Authorization": "Bearer ",
+ "user-agent": "logzio-go-logs-otlp",
+ }),
+ otlploghttp.WithURLPath("/v1/logs"),
+ )
+ if err != nil {
+ return nil, fmt.Errorf("failed to create OTLP HTTP exporter: %w", err)
+ }
+
+ loggerProvider := log.NewLoggerProvider(
+ log.WithProcessor(log.NewBatchProcessor(stdoutExporter)),
+ log.WithProcessor(log.NewBatchProcessor(httpExporter)),
+ )
+
+ return loggerProvider, nil
+ }
+
+ ```
+
+ {@include: ../../_include/log-shipping/log-shipping-token.md}
+
+
+3. Run your **application** once again:
+
+ ```bash
+ go run .
+ ```
+
+4. From another terminal, send a request using curl:
+
+ ```bash
+ curl localhost:8080/rolldice
+ ```
+5. After about 30 sec, stop the server process.
+
+At this point, you should see log output from the server and client on your Logz.io account.
+
+
+
+
+
## Traces
diff --git a/docs/shipping/Code/node-js.md b/docs/shipping/Code/node-js.md
index efb96150..4bf47502 100644
--- a/docs/shipping/Code/node-js.md
+++ b/docs/shipping/Code/node-js.md
@@ -372,50 +372,61 @@ The following example uses a basic Express application in Node.js
### Create and launch an HTTP Server
-To begin, set up an environment in a new directory called nodejs-simple. Within that directory, execute the following commands:
+1. Set up an environment in a new directory called `nodejs-simple`:
-```bash
-npm init -y
-```
-
-```bash
-npm install express
-```
-In the same directory, Ccreate a file named app.js and add the following code:
+ ```bash
+ mkdir nodejs-simple
+ cd nodejs-simple
+ npm init -y
+ ```
-```javascript
-const express = require('express');
+2. Install Express JS:
-const PORT = parseInt(process.env.PORT || '8080');
-const app = express();
+ ```bash
+ npm install express
+ ```
-function getRandomNumber(min, max) {
- return Math.floor(Math.random() * (max - min + 1)) + min;
-}
+3. In this directory, create a file named `app.js` and add the following code:
-app.get('/rolldice', (req, res) => {
- res.send(getRandomNumber(1, 6).toString());
-});
+ ```javascript
+ const express = require('express');
+
+ const PORT = parseInt(process.env.PORT || '8080');
+ const app = express();
+
+ function getRandomNumber(min, max) {
+ return Math.floor(Math.random() * (max - min + 1)) + min;
+ }
+
+ app.get('/rolldice', (req, res) => {
+ res.send(getRandomNumber(1, 6).toString());
+ });
+
+ app.listen(PORT, () => {
+ console.log(`Listening for requests on http://localhost:${PORT}`);
+ });
+
+ ```
-app.listen(PORT, () => {
- console.log(`Listening for requests on http://localhost:${PORT}`);
-});
+4. Run the application with the following command:
-```
+ ```bash
+ node app.js
+ ```
-Run the application with the following command:
+5. Open http://localhost:8080/rolldice in your web browser to ensure it is working.
-```bash
-node app.js
-```
-Open http://localhost:8080/rolldice in your web browser to ensure it is working.
+### Instrumentation
+Next, we'll configure the OpenTelemetry logging exporter to send logs to Logz.io via the OTLP listener.
-### Instrumentation
+This configuration is designed to send logs to your Logz.io account via the OpenTelemetry Protocol (OTLP) listener. You need to specify your Logz.io token and configure the listener endpoint to match the correct region. By default, the endpoint is `https://otlp-listener.logz.io/v1/logs`, but it should be adjusted based on your region. You can find more details on the regional configurations in the [Hosting Regions Documentation](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/#available-regions).
-Next, we’ll install the necessary packages for logging telemetry data to Logz.io using OpenTelemetry.
+:::note
+Ensure that you include the `user-agent` header in the format: `"user-agent=logzio-python-logs-otlp"`.
+:::
1. Add the packages
@@ -423,9 +434,7 @@ Next, we’ll install the necessary packages for logging telemetry data to Logz.
npm install winston axios
```
-2. Create a custom Logz.io transport for Winston
-
- Create a file named logzio-transport.js and add the following code:
+2. Create a custom Logz.io transport for Winston with a file named `logzio-transport.js` and add the following code:
```javascript
const Transport = require('winston-transport');
@@ -453,6 +462,7 @@ Next, we’ll install the necessary packages for logging telemetry data to Logz.
headers: {
'Authorization': `Bearer ${this.token}`,
'Content-Type': 'application/json',
+ 'user-agent': 'logzio-nodejs-logs-otlp',
},
})
.then(() => callback())
@@ -464,12 +474,9 @@ Next, we’ll install the necessary packages for logging telemetry data to Logz.
}
module.exports = LogzIoTransport;
-
```
-3. Set up the logging configuration:
-
- In your app.js, replace the content with the following:
+3. Set up the logging configuration in your `app.js`, by replacing its content with the following:
```javascript
const express = require('express');
@@ -506,13 +513,14 @@ Next, we’ll install the necessary packages for logging telemetry data to Logz.
console.log(`Listening for requests on http://localhost:${PORT}`);
});
```
+
+ {@include: ../../_include/log-shipping/log-shipping-token.md}
4. Run your **application** once again:
```bash
node app.js
```
- Note the output from the dotnet run.
4. From another terminal, send a request using curl:
diff --git a/docs/shipping/Code/python.md b/docs/shipping/Code/python.md
index dc78526e..564d63d8 100644
--- a/docs/shipping/Code/python.md
+++ b/docs/shipping/Code/python.md
@@ -334,10 +334,14 @@ The following example uses a basic Flask application.
### Create and launch an HTTP Server
-To begin, set up an environment in a new directory called `otel-getting-started`. Within that directory, follow these steps:
+1. Set up an environment in a new directory called `otel-getting-started`:
+ ```bash
+ mkdir otel-getting-started
+ cd otel-getting-started
+ ```
-1. Create and activate a virtual environment:
+2. Create and activate a virtual environment:
```bash
mkdir otel-getting-started
@@ -346,13 +350,13 @@ To begin, set up an environment in a new directory called `otel-getting-started`
source venv/bin/activate
```
-2. Install Flask and OpenTelemetry dependencies:
+3. Install Flask and OpenTelemetry dependencies:
```bash
pip install flask opentelemetry-api opentelemetry-sdk opentelemetry-exporter-otlp
```
-3. Create a Flask application in a file named app.py and add the following code:
+4. Create a Flask application in a file named app.py and add the following code:
```python
from flask import Flask
@@ -386,7 +390,7 @@ To begin, set up an environment in a new directory called `otel-getting-started`
```
-4. Run the application:
+5. Run the application:
``` bash
python app.py
@@ -397,7 +401,13 @@ Open http://localhost:8080/rolldice in your web browser to ensure it is working.
### Instrumentation
-Next, we'll configure the OpenTelemetry logging exporter to send logs to Logz.io.
+Next, we'll configure the OpenTelemetry logging exporter to send logs to Logz.io via the OTLP listener.
+
+This configuration is designed to send logs to your Logz.io account via the OpenTelemetry Protocol (OTLP) listener. You need to specify your Logz.io token and configure the listener endpoint to match the correct region. By default, the endpoint is `https://otlp-listener.logz.io/v1/logs`, but it should be adjusted based on your region. You can find more details on the regional configurations in the [Hosting Regions Documentation](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/#available-regions).
+
+:::note
+Ensure that you include the `user-agent` header in the format: `"user-agent=logzio-python-logs-otlp"`.
+:::
1. Install OpenTelemetry dependencies:
@@ -422,7 +432,7 @@ Next, we'll configure the OpenTelemetry logging exporter to send logs to Logz.io
# Configuration
service_name = "roll-dice"
- logzio_endpoint = "https://otlp-listener.logz.io/v1/logs"
+ logzio_endpoint = "https://otlp-listener.logz.io/v1/logs" # Update this to match your region if needed
logzio_token = "<>"
# Set up OpenTelemetry resources
@@ -433,7 +443,10 @@ Next, we'll configure the OpenTelemetry logging exporter to send logs to Logz.io
set_logger_provider(logger_provider)
log_exporter = OTLPLogExporter(
endpoint=logzio_endpoint,
- headers={"Authorization": f"Bearer {logzio_token}"}
+ headers={
+ "Authorization": f"Bearer {logzio_token}",
+ "user-agent": "logzio-python-logs-otlp"
+ }
)
logger_provider.add_log_record_processor(BatchLogRecordProcessor(log_exporter))
@@ -472,6 +485,7 @@ Next, we'll configure the OpenTelemetry logging exporter to send logs to Logz.io
if __name__ == "__main__":
app.run(host="0.0.0.0", port=8080)
+
```
{@include: ../../_include/log-shipping/log-shipping-token.md}
From b9f196a7ceadcd098aca09f793c85df293bce964 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9Cnico-shishkin=E2=80=9D?=
<“nicoshishkinatlogz@outlook.com”>
Date: Thu, 22 Aug 2024 14:43:01 +0100
Subject: [PATCH 09/13] Edit tabs
---
docs/shipping/Code/go.md | 2 +-
docs/shipping/Code/node-js.md | 2 +-
docs/shipping/Code/python.md | 3 +--
3 files changed, 3 insertions(+), 4 deletions(-)
diff --git a/docs/shipping/Code/go.md b/docs/shipping/Code/go.md
index d8ae69e2..5a12b87f 100644
--- a/docs/shipping/Code/go.md
+++ b/docs/shipping/Code/go.md
@@ -654,7 +654,7 @@ Ensure that you include the `user-agent` header in the format: `"user-agent=logz
At this point, you should see log output from the server and client on your Logz.io account.
-
+
diff --git a/docs/shipping/Code/node-js.md b/docs/shipping/Code/node-js.md
index b7477b84..26df0c75 100644
--- a/docs/shipping/Code/node-js.md
+++ b/docs/shipping/Code/node-js.md
@@ -532,7 +532,7 @@ Ensure that you include the `user-agent` header in the format: `"user-agent=logz
At this point, you should see log output from the server and client on your Logz.io account.
-
+
diff --git a/docs/shipping/Code/python.md b/docs/shipping/Code/python.md
index 564d63d8..9f5d199c 100644
--- a/docs/shipping/Code/python.md
+++ b/docs/shipping/Code/python.md
@@ -506,8 +506,7 @@ Ensure that you include the `user-agent` header in the format: `"user-agent=logz
At this point, you should see log output from the server and client on your Logz.io account.
-
-
+
From 45c0bf2c28e8fe462f5ddb8ef048afb8dce2a6a0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9Cnico-shishkin=E2=80=9D?=
<“nicoshishkinatlogz@outlook.com”>
Date: Thu, 22 Aug 2024 14:46:08 +0100
Subject: [PATCH 10/13] edit
---
docs/shipping/Code/python.md | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/docs/shipping/Code/python.md b/docs/shipping/Code/python.md
index 9f5d199c..e0edbccb 100644
--- a/docs/shipping/Code/python.md
+++ b/docs/shipping/Code/python.md
@@ -514,8 +514,7 @@ At this point, you should see log output from the server and client on your Logz
Send custom metrics to Logz.io from your Python application. This example uses [OpenTelemetry Python SDK](https://github.com/open-telemetry/opentelemetry-python-contrib) and the [OpenTelemetry remote write exporter](https://pypi.org/project/opentelemetry-exporter-prometheus-remote-write/).
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
+
From d86260b702193b84692ce007d1ad63c8bf21c45d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=9Cnico-shishkin=E2=80=9D?=
<“nicoshishkinatlogz@outlook.com”>
Date: Mon, 26 Aug 2024 09:40:53 +0100
Subject: [PATCH 11/13] Update OTEL SDKSs
---
docs/shipping/Code/dotnet.md | 5 +-
docs/shipping/Code/go.md | 180 ++++++++++++++--------------------
docs/shipping/Code/node-js.md | 172 --------------------------------
3 files changed, 75 insertions(+), 282 deletions(-)
diff --git a/docs/shipping/Code/dotnet.md b/docs/shipping/Code/dotnet.md
index c9eb0679..03a387fa 100644
--- a/docs/shipping/Code/dotnet.md
+++ b/docs/shipping/Code/dotnet.md
@@ -1271,9 +1271,7 @@ Next, we'll configure the OpenTelemetry logging exporter to send logs to Logz.io
This configuration is designed to send logs to your Logz.io account via the OpenTelemetry Protocol (OTLP) listener. You need to specify your Logz.io token and configure the listener endpoint to match the correct region. By default, the endpoint is `https://otlp-listener.logz.io/v1/logs`, but it should be adjusted based on your region. You can find more details on the regional configurations in the [Hosting Regions Documentation](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/#available-regions).
-:::note
-Ensure that you include the `user-agent` header in the format: `"user-agent=logzio-python-logs-otlp"`.
-:::
+
1. Add the packages
@@ -1319,6 +1317,7 @@ Ensure that you include the `user-agent` header in the format: `"user-agent=logz
```
{@include: ../../_include/log-shipping/log-shipping-token.md}
+ Update the `listener.logz.io` parth in `https://otlp-listener.logz.io/v1/logs` with the URL for [your hosting region](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region).
3. Run your **application** once again:
diff --git a/docs/shipping/Code/go.md b/docs/shipping/Code/go.md
index 5a12b87f..e27dd84b 100644
--- a/docs/shipping/Code/go.md
+++ b/docs/shipping/Code/go.md
@@ -492,9 +492,7 @@ Next, we'll configure the OpenTelemetry logging exporter to send logs to Logz.io
This configuration is designed to send logs to your Logz.io account via the OpenTelemetry Protocol (OTLP) listener. You need to specify your Logz.io token and configure the listener endpoint to match the correct region. By default, the endpoint is `https://otlp-listener.logz.io/v1/logs`, but it should be adjusted based on your region. You can find more details on the regional configurations in the [Hosting Regions Documentation](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/#available-regions).
-:::note
-Ensure that you include the `user-agent` header in the format: `"user-agent=logzio-python-logs-otlp"`.
-:::
+
1. Install OpenTelemetry dependencies:
@@ -509,133 +507,101 @@ Ensure that you include the `user-agent` header in the format: `"user-agent=logz
```go
- package main
+ // Copyright The OpenTelemetry Authors
+ // SPDX-License-Identifier: Apache-2.0
+
+ package main
+
import (
- "context"
- "errors"
- "fmt"
- "time"
+ "context"
+ "errors"
+ "fmt"
- "go.opentelemetry.io/otel"
- "go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp"
- "go.opentelemetry.io/otel/exporters/stdout/stdoutlog"
- "go.opentelemetry.io/otel/exporters/stdout/stdoutmetric"
- "go.opentelemetry.io/otel/log/global"
- "go.opentelemetry.io/otel/propagation"
- "go.opentelemetry.io/otel/sdk/log"
- "go.opentelemetry.io/otel/sdk/metric"
- "go.opentelemetry.io/otel/sdk/trace"
+ "go.opentelemetry.io/otel"
+ "go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploghttp"
+ "go.opentelemetry.io/otel/exporters/stdout/stdoutlog"
+ "go.opentelemetry.io/otel/log/global"
+ "go.opentelemetry.io/otel/propagation"
+ "go.opentelemetry.io/otel/sdk/log"
)
+ // setupOTelSDK bootstraps the OpenTelemetry pipeline.
+ // If it does not return an error, make sure to call shutdown for proper cleanup.
func setupOTelSDK(ctx context.Context) (shutdown func(context.Context) error, err error) {
- var shutdownFuncs []func(context.Context) error
+ var shutdownFuncs []func(context.Context) error
- shutdown = func(ctx context.Context) error {
- var err error
- for _, fn := range shutdownFuncs {
- err = errors.Join(err, fn(ctx))
- }
- shutdownFuncs = nil
- return err
- }
+ // shutdown calls cleanup functions registered via shutdownFuncs.
+ // The errors from the calls are joined.
+ // Each registered cleanup will be invoked once.
+ shutdown = func(ctx context.Context) error {
+ var err error
+ for _, fn := range shutdownFuncs {
+ err = errors.Join(err, fn(ctx))
+ }
+ shutdownFuncs = nil
+ return err
+ }
- handleErr := func(inErr error) {
- err = errors.Join(inErr, shutdown(ctx))
- }
-
- prop := newPropagator()
- otel.SetTextMapPropagator(prop)
-
- tracerProvider, err := newTraceProvider()
- if err != nil {
- handleErr(err)
- return
- }
- shutdownFuncs = append(shutdownFuncs, tracerProvider.Shutdown)
- otel.SetTracerProvider(tracerProvider)
+ // handleErr calls shutdown for cleanup and makes sure that all errors are returned.
+ handleErr := func(inErr error) {
+ err = errors.Join(inErr, shutdown(ctx))
+ }
- meterProvider, err := newMeterProvider()
- if err != nil {
- handleErr(err)
- return
- }
- shutdownFuncs = append(shutdownFuncs, meterProvider.Shutdown)
- otel.SetMeterProvider(meterProvider)
+ // Set up propagator.
+ prop := newPropagator()
+ otel.SetTextMapPropagator(prop)
- loggerProvider, err := newLoggerProvider()
- if err != nil {
- handleErr(err)
- return
- }
- shutdownFuncs = append(shutdownFuncs, loggerProvider.Shutdown)
- global.SetLoggerProvider(loggerProvider)
+ // Set up logger provider.
+ loggerProvider, err := newLoggerProvider()
+ if err != nil {
+ handleErr(err)
+ return
+ }
+ shutdownFuncs = append(shutdownFuncs, loggerProvider.Shutdown)
+ global.SetLoggerProvider(loggerProvider)
- return
+ return
}
func newPropagator() propagation.TextMapPropagator {
- return propagation.NewCompositeTextMapPropagator(
- propagation.TraceContext{},
- propagation.Baggage{},
- )
- }
-
- func newTraceProvider() (*trace.TracerProvider, error) {
- traceExporter, err := stdouttrace.New(
- stdouttrace.WithPrettyPrint())
- if err != nil {
- return nil, err
- }
-
- traceProvider := trace.NewTracerProvider(
- trace.WithBatcher(traceExporter,
- trace.WithBatchTimeout(time.Second)),
- )
- return traceProvider, nil
- }
-
- func newMeterProvider() (*metric.MeterProvider, error) {
- metricExporter, err := stdoutmetric.New()
- if err != nil {
- return nil, err
- }
-
- meterProvider := metric.NewMeterProvider(
- metric.WithReader(metric.NewPeriodicReader(metricExporter,
- metric.WithInterval(3*time.Second))),
- )
- return meterProvider, nil
+ return propagation.NewCompositeTextMapPropagator(
+ propagation.TraceContext{},
+ propagation.Baggage{},
+ )
}
func newLoggerProvider() (*log.LoggerProvider, error) {
- stdoutExporter, err := stdoutlog.New(stdoutlog.WithPrettyPrint())
- if err != nil {
- return nil, fmt.Errorf("failed to create stdout exporter: %w", err)
- }
+ // Create stdout log exporter
+ stdoutExporter, err := stdoutlog.New(stdoutlog.WithPrettyPrint())
+ if err != nil {
+ return nil, fmt.Errorf("failed to create stdout exporter: %w", err)
+ }
- httpExporter, err := otlploghttp.New(context.Background(),
- otlploghttp.WithEndpoint("otlp-listener.logz.io"),
- otlploghttp.WithHeaders(map[string]string{
- "Authorization": "Bearer ",
- "user-agent": "logzio-go-logs-otlp",
- }),
- otlploghttp.WithURLPath("/v1/logs"),
- )
- if err != nil {
- return nil, fmt.Errorf("failed to create OTLP HTTP exporter: %w", err)
- }
+ // Create OTLP HTTP log exporter for Logz.io
+ httpExporter, err := otlploghttp.New(context.Background(),
+ otlploghttp.WithEndpoint("otlp-listener.logz.io"),
+ otlploghttp.WithHeaders(map[string]string{
+ "Authorization": "Bearer ",
+ }),
+ otlploghttp.WithURLPath("/v1/logs"),
+ )
+ if err != nil {
+ return nil, fmt.Errorf("failed to create OTLP HTTP exporter: %w", err)
+ }
- loggerProvider := log.NewLoggerProvider(
- log.WithProcessor(log.NewBatchProcessor(stdoutExporter)),
- log.WithProcessor(log.NewBatchProcessor(httpExporter)),
- )
+ // Create a logger provider with both exporters
+ loggerProvider := log.NewLoggerProvider(
+ log.WithProcessor(log.NewBatchProcessor(stdoutExporter)), // For stdout
+ log.WithProcessor(log.NewBatchProcessor(httpExporter)), // For HTTP export
+ )
- return loggerProvider, nil
+ return loggerProvider, nil
}
-
```
+
{@include: ../../_include/log-shipping/log-shipping-token.md}
+ Update the `listener.logz.io` parth in `https://otlp-listener.logz.io/v1/logs` with the URL for [your hosting region](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region).
3. Run your **application** once again:
diff --git a/docs/shipping/Code/node-js.md b/docs/shipping/Code/node-js.md
index 26df0c75..8a138b90 100644
--- a/docs/shipping/Code/node-js.md
+++ b/docs/shipping/Code/node-js.md
@@ -360,179 +360,7 @@ logger.log(obj);
```
-
-### Prerequisites
-
-Ensure that you have the following installed locally:
-- [Node.js](https://nodejs.org/) (latest LTS version recommended)
-
-### Example Application
-The following example uses a basic Express application in Node.js
-
-### Create and launch an HTTP Server
-
-1. Set up an environment in a new directory called `nodejs-simple`:
-
-
- ```bash
- mkdir nodejs-simple
- cd nodejs-simple
- npm init -y
- ```
-
-2. Install Express JS:
-
- ```bash
- npm install express
- ```
-
-3. In this directory, create a file named `app.js` and add the following code:
-
- ```javascript
- const express = require('express');
-
- const PORT = parseInt(process.env.PORT || '8080');
- const app = express();
-
- function getRandomNumber(min, max) {
- return Math.floor(Math.random() * (max - min + 1)) + min;
- }
-
- app.get('/rolldice', (req, res) => {
- res.send(getRandomNumber(1, 6).toString());
- });
-
- app.listen(PORT, () => {
- console.log(`Listening for requests on http://localhost:${PORT}`);
- });
-
- ```
-
-4. Run the application with the following command:
-
- ```bash
- node app.js
- ```
-
-5. Open http://localhost:8080/rolldice in your web browser to ensure it is working.
-
-
-### Instrumentation
-
-Next, we'll configure the OpenTelemetry logging exporter to send logs to Logz.io via the OTLP listener.
-
-This configuration is designed to send logs to your Logz.io account via the OpenTelemetry Protocol (OTLP) listener. You need to specify your Logz.io token and configure the listener endpoint to match the correct region. By default, the endpoint is `https://otlp-listener.logz.io/v1/logs`, but it should be adjusted based on your region. You can find more details on the regional configurations in the [Hosting Regions Documentation](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/#available-regions).
-
-:::note
-Ensure that you include the `user-agent` header in the format: `"user-agent=logzio-python-logs-otlp"`.
-:::
-
-
-1. Add the packages
- ```bash
- npm install winston axios
- ```
-
-2. Create a custom Logz.io transport for Winston with a file named `logzio-transport.js` and add the following code:
-
- ```javascript
- const Transport = require('winston-transport');
- const axios = require('axios');
-
- class LogzIoTransport extends Transport {
- constructor(opts) {
- super(opts);
- this.endpoint = opts.endpoint;
- this.token = opts.token;
- this.serviceName = opts.serviceName;
- }
-
- log(info, callback) {
- setImmediate(() => this.emit('logged', info));
-
- const logEntry = {
- message: info.message,
- level: info.level,
- service: this.serviceName,
- ...info.meta,
- };
-
- axios.post(this.endpoint, logEntry, {
- headers: {
- 'Authorization': `Bearer ${this.token}`,
- 'Content-Type': 'application/json',
- 'user-agent': 'logzio-nodejs-logs-otlp',
- },
- })
- .then(() => callback())
- .catch(err => {
- console.error('Error sending log to Logz.io:', err);
- callback();
- });
- }
- }
-
- module.exports = LogzIoTransport;
- ```
-
-3. Set up the logging configuration in your `app.js`, by replacing its content with the following:
-
- ```javascript
- const express = require('express');
- const winston = require('winston');
- const LogzIoTransport = require('./logzio-transport');
-
- const PORT = process.env.PORT || 8080;
- const app = express();
-
- const logger = winston.createLogger({
- level: 'info',
- format: winston.format.json(),
- transports: [
- new LogzIoTransport({
- endpoint: 'https://listener.logz.io:8071',
- token: '',
- serviceName: 'nodejs-roll-dice',
- }),
- ],
- });
-
- function getRandomNumber(min, max) {
- return Math.floor(Math.random() * (max - min + 1)) + min;
- }
-
- app.get('/rolldice', (req, res) => {
- const result = getRandomNumber(1, 6);
- logger.info(`Rolled dice: ${result}`);
- res.send(result.toString());
- });
-
- app.listen(PORT, () => {
- logger.info(`Listening for requests on http://localhost:${PORT}`);
- console.log(`Listening for requests on http://localhost:${PORT}`);
- });
- ```
-
- {@include: ../../_include/log-shipping/log-shipping-token.md}
-
-4. Run your **application** once again:
-
- ```bash
- node app.js
- ```
-
-4. From another terminal, send a request using curl:
-
- ```
- curl localhost:8080/rolldice
- ```
-5. After about 30 sec, stop the server process.
-
-At this point, you should see log output from the server and client on your Logz.io account.
-
-
-
From 262199e61bc5a0526e3fa5402eac811f04b4371f Mon Sep 17 00:00:00 2001
From: Simplychee
Date: Mon, 26 Aug 2024 11:44:02 +0300
Subject: [PATCH 12/13] new code block
---
.../notification-endpoints/ms-teams.md | 49 ++++++++++++-------
1 file changed, 32 insertions(+), 17 deletions(-)
diff --git a/docs/user-guide/integrations/notification-endpoints/ms-teams.md b/docs/user-guide/integrations/notification-endpoints/ms-teams.md
index bf8c9b21..1291d3df 100644
--- a/docs/user-guide/integrations/notification-endpoints/ms-teams.md
+++ b/docs/user-guide/integrations/notification-endpoints/ms-teams.md
@@ -55,25 +55,40 @@ To use this example in your own endpoint, copy the payload. Note that double-bra
```
{
- "type": "message",
- "attachments": [
- {
- "contentType": "application/vnd.microsoft.card.adaptive",
- "contentUrl": null,
- "content": {
- "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
- "type": "AdaptiveCard",
- "version": "1.2",
- "body": [
- {
- "type": "TextBlock",
- "text": "Submitted response:"
- }
- ]
- }
- }
+ "type": "message",
+ "attachments": [
+ {
+ "contentType": "application/vnd.microsoft.card.adaptive",
+ "contentUrl": null,
+ "content": {
+ "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
+ "type": "AdaptiveCard",
+ "version": "1.2",
+ "body": [
+ {
+ "type": "TextBlock",
+ "text": "title: {{alert_severity}}: {{alert_title}}"
+ },
+ {
+ "type": "TextBlock",
+ "text": "summary: {{alert_description}}"
+ },
+ {
+ "type": "TextBlock",
+ "text": "text: {{alert_samples}}"
+ }
+ ],
+ "actions": [
+ {
+ "type": "Action.OpenUrl",
+ "title": "View in OpenSearch Dashboards",
+ "url": "{{alert_app_url}}#/view-triggered-alert?from={{alert_timeframe_start_epoch_millis}}&to={{alert_timeframe_end_epoch_millis}}&definitionId={{alert_definition_id}}&switchToAccountId={{account_id}}"
+ }
]
+ }
}
+ ]
+}
```
From 7823d5223c16676c6a9c354f752c7513a3c8dd64 Mon Sep 17 00:00:00 2001
From: Simplychee
Date: Mon, 26 Aug 2024 12:08:39 +0300
Subject: [PATCH 13/13] images
---
docs/user-guide/app360/service-list.md | 16 +++++++++++-----
docs/user-guide/k8s-360/kubernetes-360-pre.md | 4 +---
2 files changed, 12 insertions(+), 8 deletions(-)
diff --git a/docs/user-guide/app360/service-list.md b/docs/user-guide/app360/service-list.md
index f6354393..ba094ff4 100644
--- a/docs/user-guide/app360/service-list.md
+++ b/docs/user-guide/app360/service-list.md
@@ -63,17 +63,17 @@ Clicking on one of the services or clicking on drill down opens a dashboard with
You can change the time frame and add additional filters, including comparing the data to a previous period or choose an environment, nodes, and pods. Clicking the refresh button will manually update the data.
-
+
Hovering over the graphs provides additional info for the time point you've chosen:
* The **Request rate** graph shows the number of requests made per minute
* The **Latency** graph provides a milliseconds count of how long it takes for data to travel in your environment
-* The **Errors** graph analyzes the percentage of errors that occurred
-* The **HTTP status code** graph measures the distribution of various HTTP status codes
+* The **Error Ratio** graph analyzes the percentage of errors that occurred
+* The **Status code** graph measures the distribution of various HTTP status codes
-
+
### Operations overview
@@ -87,7 +87,7 @@ This table includes all of the operations running inside the chosen service with
Use the search bar to find a specific operation or the arrows at the bottom of the table to navigate the operations.
-
+
### (Single) Operation overview
@@ -174,6 +174,12 @@ Once your anomaly detector is up and running, you'll see an indicator in the lis
+## AI Assistant
+
+Click the **AI Assistant** button to activate the [Observability IQ Assistant](https://docs.logz.io/docs/user-guide/observability/assistantiq), an AI-powered, chat-based interface that lets you engage in a dynamic conversation with your data. Use one of the pre-configured prompts or type your own question to get real-time insights about your metrics, anomalies, trends, and the overall health of your environment.
+
+
+
diff --git a/docs/user-guide/k8s-360/kubernetes-360-pre.md b/docs/user-guide/k8s-360/kubernetes-360-pre.md
index 0644b41d..f8d415f2 100644
--- a/docs/user-guide/k8s-360/kubernetes-360-pre.md
+++ b/docs/user-guide/k8s-360/kubernetes-360-pre.md
@@ -11,9 +11,7 @@ slug: /user-guide/k8s-360/kubernetes-360-pre
Kubernetes 360 application provides an overview of your Kubernetes data, providing a quick overview of your current deployments, pods, and more useful information regarding your environment.
-
-
-
+