From 7dd2675ff950cf72017e561467f27cad765adf5b Mon Sep 17 00:00:00 2001 From: Alekh Nema Date: Mon, 15 Jul 2024 21:48:11 +0530 Subject: [PATCH 01/13] Changes for cassandra opentelemetry doc after with metric collection and dashbaords --- .../opentelemetry/cassandra-opentelemetry.md | 78 ++++++++++++++++++- 1 file changed, 74 insertions(+), 4 deletions(-) diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index bad7a0d63e..081000fcfb 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -11,9 +11,9 @@ import TabItem from '@theme/TabItem'; Thumbnail icon Thumbnail icon -The [Cassandra](https://cassandra.apache.org/_/cassandra-basics.html) - OpenTelemetry app is a log based app that helps you monitor the availability, performance, health, and resource utilization of your Cassandra clusters. Preconfigured dashboards provide insight into resource utilization, cache/Gossip/Memtable statistics and Error and warnings. Cassandra logs are sent to Sumo Logic through OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver). +The [Cassandra](https://cassandra.apache.org/_/cassandra-basics.html) - OpenTelemetry app is a log and metric based app that helps you monitor the availability, performance, health, and resource utilization of your Cassandra clusters. Preconfigured dashboards provide insight into resource utilization, cache/Gossip/Memtable statistics and Error and warnings along with the request served and latency, storage and compaction related metrics. Cassandra logs are sent to Sumo Logic through OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) and cassandra metrics are sent to Sumo Logic using [JMX opentelemetry receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) with the `target_system` set as [`cassandra`](https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/docs/target-systems/cassandra.md) -The app supports Logs from the open-source version of Cassandra. The App is tested on the 3.11.10 version of Cassandra. +The app supports Logs from the open-source version of Cassandra. The App is tested on the 4.0.0 version of Cassandra. Schematics @@ -21,13 +21,27 @@ The app supports Logs from the open-source version of Cassandra. The App is test Following are the [Fields](/docs/manage/fields/) which will be created as part of Cassandra App install if not already present: +- `deployment.environment`. User configured. Through this Cassandra cluster is identified by the environment where it resides. For example: dev, prod or qa. - `db.cluster.name`. User configured. Enter a name to identify this Cassandra cluster. This cluster name will be shown in the Sumo Logic dashboards. - `db.system`. Has fixed value of **cassandra**. -- `deployment.environment`. User configured. Through this Cassandra cluster is identified by the environment where it resides. For example: dev, prod or qa. +- `db.node.name`. Holds the value of the Fully Qualified Domain Name (FQDN) of the machine from which the OpenTelemetry collector is collecting logs and metrics. - `sumo.datasource`. Has fixed value of **cassandra**. ## Prerequisites +#### For metric collection + +JMX receiver collects Cassandra metrics from Cassandra server as part of the OpenTelemetry Collector (OTC). + + 1. Follow the instructions in [JMX - OpenTelemetry's prerequisites section](/docs/integrations/app-development/opentelemetry/jmx-opentelemetry/#prerequisites) to download the [JMX Metric Gatherer](https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/README.md). This gatherer is used by the [JMX Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver#details). + + 2. Set the JMX port by setting it as part of `JAVA_OPTS` for Tomcat startup. Usually it is set in the `/etc/systemd/system/cassandra.service` or `C:\Program Files\apache-tomcat\bin\tomcat.bat` file. + + ```json + JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=11099 -Dcom.sun.management.jmxremote.authenticate=true -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.password.file=${CASSANDRA_CONF_DIR}/jmx.password -Dcom.sun.management.jmxremote.access.file=${CASSANDRA_CONF_DIR}/jmx.access" + ``` + +#### For log collection Cassandra has three main logs: system.log, debug.log, and gc.log which hold general logging messages, debugging logging messages, and java garbage collection logs respectively. These logs by default live in `${CASSANDRA_HOME}/logs`, but most Linux distributions relocate logs to `/var/log/cassandra`. Operators can tune this location as well as what levels are logged using the provided logback.xml file. For more details on Cassandra logs, see[ this](https://cassandra.apache.org/doc/latest/troubleshooting/reading_logs.html) link. @@ -56,6 +70,7 @@ In this step, you will configure the yaml required for Cassandra Collection. Pat Below are the inputs required: - The path to system.log is required here. This file is typically located in `/var/log/cassandra`. If you're using a customized path, check the respective conf file for this information. +- For metrics, you're required to provide the JMX endpoint (default is `localhost:7199`) along with the `collection_interval` (default is 1 minute). You can add any custom fields which you want to be tagged with the data ingested in Sumo. Click on the **Download YAML File** button to get the yaml file. @@ -122,7 +137,41 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; INFO [ScheduledTasks:1] 2023-01-08 09:18:47,347 StatusLogger.java:101 - system.schema_aggregates ``` -## Sample queries  +## Sample metric message +{ + "queryId": "A", + "_source": "cassandra-otel", + "_metricId": "dasIFS6RvCVxEcsljWGpnQ", + "_sourceName": "Http Input", + "host.id": "i-071ade75d03650657", + "host.group": "cassandraHostGrp", + "telemetry.sdk.version": "1.38.0", + "os.type": "linux", + "sumo.datasource": "cassandra", + "db.system": "cassandra", + "db.node.name": "ip-54-163-607-30.ec2.internal", + "_sourceCategory": "Labs/cassandra-otel", + "deployment.environment": "dev", + "_contentType": "Carbon2", + "host.name": "ip-54-163-607-30.ec2.internal", + "metric": "cassandra.client.request.write.latency.50p", + "_collectorId": "000000000FB3B451", + "_sourceId": "000000005A60F624", + "unit": "us", + "db.cluster.name": "cassandra_cluster", + "telemetry.sdk.language": "java", + "telemetry.sdk.name": "opentelemetry", + "service.name": "unknown_service:java", + "_collector": "Labs - cassandra-otel", + "max": 229, + "min": 0, + "avg": 131.25, + "sum": 525, + "latest": 67, + "count": 4 +} + +## Sample Log queries  Following is the query from Cassandra App's overview Dashboard's Nodes Up Panel: @@ -136,6 +185,13 @@ Following is the query from Cassandra App's overview Dashboard's Nodes Up Panel: | sort by _timeslice asc ``` +## Sample Metrics queries  +Following is the query from Cassandra App's overview Dashboard's Number of Requests Panel: + +```sql +sumo.datasource=cassandra deployment.environment=* db.cluster.name=* db.node.name=* metric=cassandra.client.request.count | sum +``` + ## Viewing Cassandra Dashboards ### Overview @@ -202,3 +258,17 @@ Use this dashboard to: - Identify resource utilization. This can help you to determine whether resources are over-allocated or under-allocated. Resource Usage + +### Compaction + +The Cassandra - Compactions dashboard provides a insight into the completed and pending compaction tasks. +Compaction + +### Requests +The Cassandra - Requests dashboard gives insight into the number of request served, number of error request and their distribution by status and operation. Also you can monitor the read and write latency of the cluster instance using this dashboard. +Requests + +### Storage +The Cassandra - Storage dashboard provides insight into the current value of total hints of your cassandra cluster along with storage managed by the cluster. + +Storage \ No newline at end of file From a9097418ff47870fba967ce3c735db5ee708099b Mon Sep 17 00:00:00 2001 From: Ankur Chaudhary Date: Mon, 22 Jul 2024 12:21:04 +0530 Subject: [PATCH 02/13] added initial doc changes for vmware otel app --- .../opentelemetry/vmware-opentelemetry.md | 262 ++++++++++++++++++ 1 file changed, 262 insertions(+) create mode 100644 docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md new file mode 100644 index 0000000000..4abb8ba19f --- /dev/null +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -0,0 +1,262 @@ +--- +id: vmware-opentelemetry +title: VMWare - OpenTelemetry Collector +sidebar_label: VMWare - OTel Collector +description: Learn about the Sumo Logic OpenTelemetry app for VMWare. +--- + +import useBaseUrl from '@docusaurus/useBaseUrl'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +icon Thumbnail icon + +The VMware app uses unified metrics from the VMware cloud computing virtualization platform to enable monitoring of vCenter, ESXi hosts and individual virtual machines metrics with real-time date displayed in predefined dashboards. + +The dashboards provide insight into key metrics such as VM and hosts CPU, memory, disk utilization. This enables you to determine capacity constraints and troubleshoot operational issues related to over-provisioning, changes to configuration, and VM movement. + +See the [vSphere product page](https://www.vmware.com/products/vsphere.html) for more information on VMware hybrid cloud. + +Schematics + +## Fields creation in Sumo Logic for RabbitMQ + + +## Prerequisites + +This section provides instructions for configuring metrics for the Sumo Logic app for VMWare. + +#### Metric collection + +Metrics are collected through the [vCenter Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/vcenterreceiver) of OpenTelemetry. A “Read Only” user assigned to a vSphere with permissions to the vCenter server, cluster and all subsequent resources being monitored must be specified in order for the receiver to retrieve information about them. + +## Collection configuration and app installation + +import ConfigAppInstall from '../../../reuse/apps/opentelemetry/config-app-install.md'; + + + +### Step 1: Set up Collector + +import SetupColl from '../../../reuse/apps/opentelemetry/set-up-collector.md'; + + + +Collector + +### Step 2: Configure integration + +In this step, we will be configuring the yaml file required for RabbitMQ Collection. Path of the log file configured to capture RabbitMQ logs is needed to be given here. + +The files are typically located in `/var/log/rabbitmq/rabbit@.log`. You can add any custom fields which you want to tag along with the data ingested in sumo. Click on the **Download YAML File** button to get the yaml file. + +YAML + +### Step 3: Send logs to Sumo Logic + +import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; + + + + + + + +1. Copy the yaml file to `/etc/otelcol-sumo/conf.d/` folder in the RabbitMQ instance which needs to be monitored. +2. Restart the collector using: + ```sh +  sudo systemctl restart otelcol-sumo + ``` + + + + +1. Copy the yaml file to `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\conf.d` folder in the machine which needs to be monitored. +2. Restart the collector using: + ```sh + Restart-Service -Name OtelcolSumo + ``` + + + + +1. Copy the yaml file to /etc/otelcol-sumo/conf.d/ folder in the RabbitMq instance which needs to be monitored. +2. Restart the otelcol-sumo process using the below command  + ```sh +  otelcol-sumo --config /etc/otelcol-sumo/sumologic.yaml --config "glob:/etc/otelcol-sumo/conf.d/*.yaml"  + ``` + + + + +import ChefNoEnv from '../../../reuse/apps/opentelemetry/chef-without-env.md'; + + + + + + + +import AnsibleNoEnv from '../../../reuse/apps/opentelemetry/ansible-without-env.md'; + + + + + + + +import PuppetNoEnv from '../../../reuse/apps/opentelemetry/puppet-without-env.md'; + + + + + + +import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; + + + +## Sample log messages + +Here's a sample log message you'd find in Non-Kubernetes environments. + +``` +2023-01-16 05:53:44.858 [info] <0.44.0> Application cowboy exited with reason: stopped +``` + +## Sample queries + +This sample Query is from the **RabbitMQ - Logs dashboard** > **Events** by Severity panel. + +```sql title="Query String" + %"sumo.datasource"="rabbitmq" %"messaging.cluster.name"=* host.name=* +| json "log" as _rawlog nodrop +| if(isEmpty(_rawlog),_raw,_rawlog) as _raw +| parse "* * [*]" as date,time,severity | count by severity +``` + +## Sample queries + +### Metrics query + +This sample Query is from the **VMWare - Overview** > **Top 25 ESXi Hosts - CPU Utilization** panel. + +```sql title="Metric query" +sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.name=* vcenter.cluster.name=* vcenter.host.name=* | topk(25,avg) +``` + +## Sample metrics + +### Metric message + +```json title="Metric message" +{ + "queryId": "A", + "_source": "WIN-U8TUICHO2JM", + "_metricId": "-nHlUFTEN-e35PT8M0bW4Q", + "_sourceName": "vmware", + "host.group": "anemavmware", + "os.type": "windows", + "sumo.datasource": "vmware", + "_sourceCategory": "otel/vmware", + "deployment.environment": "anemavmware", + "_contentType": "OpenTelemetry", + "host.name": "WIN-U8TUICHO2JM", + "metric": "vcenter.host.cpu.utilization", + "_collectorId": "00005AF310C86B33", + "vcenter.datacenter.name": "Production", + "_sourceId": "0000000000000000", + "unit": "%", + "vcenter.cluster.name": "Prod Cluster", + "_sourceHost": "WIN-U8TUICHO2JM", + "_collector": "WIN-U8TUICHO2JM", + "vcenter.host.name": "esx1.esxlab.com", + "max": 45.76, + "min": 0, + "avg": 5.65, + "sum": 1621.41, + "latest": 0, + "count": 287 +} +``` + +## Viewing VMWare dashboards + +### VMWare - Overview + +VMWare-Overview + +- **Number of ESXi Hosts in Cluster**. The total number of ESXi hosts in the cluster. +- **Number of VMs in Cluster**. The total number of VMs in the cluster. +- **Available Cluster Memory**. Percentage of memory available in the cluster. +- **Available Cluster CPU**. Percentage of cpu available in the cluster. +- **Datastore Disk Utilization**. The disk utilization of the datastore. +- **VM Disk Usage**. The disk usage of VM. +- **Top 25 ESXi Hosts CPU Utilization**. Top 25 ESXi Hosts cpu utilization. +- **Top 25 ESXi Hosts Memory Utilization**. Top 25 ESXi Hosts memory utilization. +- **Top 25 ESXi Hosts Network Usage**. Top 25 ESXi Hosts usage. +- **Top 25 VMs CPU Utilization**. Top 25 VMs cpu utilization. +- **Top 25 VMs Memory Utilization**. Top 25 VMs memory utilization. +- **Top 25 VMs Network Usage**. Top 25 VMs network usage. +- **Top 25 VMs Memory Ballooning**. Top 25 VMs memory ballooning. + +### VMWare - Clusters + +VMWare-Clusters + +- **Number of ESXi Hosts in Cluster**. The total number of ESXi hosts in the cluster. +- **Number of VMs in Cluster**. The total number of VMs in the cluster. +- **Available Cluster CPU**. Percentage of CPU available in the cluster. +- **Available Cluster Memory**. Percentage of Memory available in the cluster. + +### VMWare - Resource Pools + +VMWare-Resource-Pools + +- **Cluster CPU Usage**. CPU usage of the resource pool. +- **Cluster Memory Usage**. Memory usage of the resource pool. +- **Shares of CPU**. Shares of CPU in the resource pool. +- **Shares of Memory**. Shares of Memory in the resource pool. + +### VMWare - Host Overview/ Details + +VMWare-Host-Overview-Details + +- **Top 25 ESXi Hosts CPU Utilization**. Top 25 ESXi Hosts cpu utilization. +- **Top 25 ESXi Hosts Memory Utilization**. Top 25 ESXi Hosts memory utilization. +- **Top 25 ESXi Hosts Network Usage**. Top 25 ESXi Hosts usage. +- **Top 25 ESXi Hosts Disk Read/ Write Latency**. Top 25 ESXi Hosts disk read/ write latency. +- **Top 25 ESXi Hosts CPU Usage**. Top 25 ESXi Hosts cpu usage. +- **Top 25 ESXi Hosts Disk Read/ Write Rate**. Top 25 ESXi Hosts disk read/ write rate. +- **Top 25 ESXi Hosts Network Throughput**. Top 25 ESXi Hosts network throughput. +- **Top 25 ESXi Hosts Network Packet Rate**. Top 25 ESXi Hosts network transmitted/ received packet rate. +- **Top 25 ESXi Hosts Network Packet Error Rate**. Top 25 ESXi Hosts network transmitted/ received packet error rate. + +### VMWare - VM Overview/ Details + +VMWare-VM-Overview-Details + +- **Top 25 VMs CPU Utilization**. Top 25 VMs cpu utilization. +- **Top 25 VMs Memory Utilization**. Top 25 VMs memory utilization. +- **Top 25 VMs Disk Utilization**. Top 25 VMs disk utilization. +- **Top 25 VMs Network Usage**. Top 25 VMs network usage. +- **Top 25 VMs Disk Usage**. Top 25 VMs disk usage. +- **Top 25 VMs CPU Usage**. Top 25 VMs cpu usage. +- **Top 25 VMs Memory Usage**. Top 25 VMs memory usage. +- **Top 25 VMs Memory Ballooning**. Top 25 VMs memory ballooning. +- **Top 25 VMs Disk Read/ Write Latency**. Top 25 VMs disk read/ write latency. +- **Top 25 VMs Disk Read/ Write Rate**. Top 25 VMs disk read/ write rate. +- **Top 25 VMs Network Throughput**. Top 25 VMs network throughput. +- **Top 25 VMs Network Packet Rate**. Top 25 VMs network transmitted/ received packet rate. +- **Top 25 VMs Network Packet Drop Rate**. Top 25 VMs network transmitted/ received packet drop rate. +- **Top 25 VMs Memory Swapped**. Top 25 VMs memory swapped. From 10238d594b938364a2c045420bb6f8999450a490 Mon Sep 17 00:00:00 2001 From: Alekh Nema Date: Mon, 22 Jul 2024 15:27:44 +0530 Subject: [PATCH 03/13] Changes for collection part of vmware opentelemetry and other minor content correction --- .../opentelemetry/vmware-opentelemetry.md | 66 ++++++++----------- 1 file changed, 29 insertions(+), 37 deletions(-) diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md index 4abb8ba19f..ef7ae95f04 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -9,26 +9,27 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -icon Thumbnail icon +VMware dashboards -The VMware app uses unified metrics from the VMware cloud computing virtualization platform to enable monitoring of vCenter, ESXi hosts and individual virtual machines metrics with real-time date displayed in predefined dashboards. +The VMware - OpenTelemetry app uses metrics from the VMware cloud computing virtualisation platform to enable monitoring of vCenter, datacenter, resource pool, cluster, ESXi hosts and individual virtual machines metrics with real-time date displayed in predefined dashboards. -The dashboards provide insight into key metrics such as VM and hosts CPU, memory, disk utilization. This enables you to determine capacity constraints and troubleshoot operational issues related to over-provisioning, changes to configuration, and VM movement. +The dashboards provide insight into key metrics such as CPU, memory, disk utilization at different infrastructure level like vm, host, datacenter, resource pool and clusters. This enables you to determine capacity constraints and troubleshoot operational issues related to over-provisioning, changes to configuration, and VM movement. -See the [vSphere product page](https://www.vmware.com/products/vsphere.html) for more information on VMware hybrid cloud. - -Schematics +VMWare metrics are collected through the [vCenter Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/vcenterreceiver) of OpenTelemetry. -## Fields creation in Sumo Logic for RabbitMQ +See the [vSphere product page](https://www.vmware.com/products/vsphere.html) for more information on VMware hybrid cloud. +Schematics ## Prerequisites +VMWare metrics are collected through the [vCenter Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/vcenterreceiver) of OpenTelemetry. -This section provides instructions for configuring metrics for the Sumo Logic app for VMWare. +This receiver has been built to support ESXi and vCenter versions: -#### Metric collection +- 8 +- 7.0 -Metrics are collected through the [vCenter Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/vcenterreceiver) of OpenTelemetry. A “Read Only” user assigned to a vSphere with permissions to the vCenter server, cluster and all subsequent resources being monitored must be specified in order for the receiver to retrieve information about them. +A “Read Only” user assigned to a vSphere with permissions to the vCenter server, cluster and all subsequent resources being monitored must be specified in order for the receiver to retrieve information about them. ## Collection configuration and app installation @@ -42,15 +43,24 @@ import SetupColl from '../../../reuse/apps/opentelemetry/set-up-collector.md'; -Collector +Collector ### Step 2: Configure integration -In this step, we will be configuring the yaml file required for RabbitMQ Collection. Path of the log file configured to capture RabbitMQ logs is needed to be given here. +In this step, we will be configuring the yaml file required for VMWare Collection. Here are the list of parameters which are required: + +- **Endpoint** to the vCenter Server or ESXi host that has the sdk path enabled. This is a required parameter. The expected format is `://` -The files are typically located in `/var/log/rabbitmq/rabbit@.log`. You can add any custom fields which you want to tag along with the data ingested in sumo. Click on the **Download YAML File** button to get the yaml file. +i.e: `https://vcsa.hostname.localnet` +- **Username** of User which has access to vcenter server +- **Password** of User which has access to vcenter server +- **collection_interval** this receiver collects metrics on an interval. If the vCenter is fairly large, this value may need to be increased. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h` -YAML +You can add any custom fields which you want to tag along with the data ingested in sumo. Click on the **Download YAML File** button to get the yaml file. + +For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + +YAML ### Step 3: Send logs to Sumo Logic @@ -72,7 +82,7 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; -1. Copy the yaml file to `/etc/otelcol-sumo/conf.d/` folder in the RabbitMQ instance which needs to be monitored. +1. Copy the yaml file to `/etc/otelcol-sumo/conf.d/` folder in the VMWare instance which has access to vCenter or the vCenter itself. 2. Restart the collector using: ```sh   sudo systemctl restart otelcol-sumo @@ -81,7 +91,7 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; -1. Copy the yaml file to `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\conf.d` folder in the machine which needs to be monitored. +1. Copy the yaml file to `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\conf.d` folder in the VMWare instance which has access to vCenter or the vCenter itself. 2. Restart the collector using: ```sh Restart-Service -Name OtelcolSumo @@ -90,7 +100,7 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; -1. Copy the yaml file to /etc/otelcol-sumo/conf.d/ folder in the RabbitMq instance which needs to be monitored. +1. Copy the yaml file to /etc/otelcol-sumo/conf.d/ folder in the VMWare instance which has access to vCenter or the vCenter itself. 2. Restart the otelcol-sumo process using the below command  ```sh  otelcol-sumo --config /etc/otelcol-sumo/sumologic.yaml --config "glob:/etc/otelcol-sumo/conf.d/*.yaml"  @@ -126,24 +136,6 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; -## Sample log messages - -Here's a sample log message you'd find in Non-Kubernetes environments. - -``` -2023-01-16 05:53:44.858 [info] <0.44.0> Application cowboy exited with reason: stopped -``` - -## Sample queries - -This sample Query is from the **RabbitMQ - Logs dashboard** > **Events** by Severity panel. - -```sql title="Query String" - %"sumo.datasource"="rabbitmq" %"messaging.cluster.name"=* host.name=* -| json "log" as _rawlog nodrop -| if(isEmpty(_rawlog),_raw,_rawlog) as _raw -| parse "* * [*]" as date,time,severity | count by severity -``` ## Sample queries @@ -165,11 +157,11 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n "_source": "WIN-U8TUICHO2JM", "_metricId": "-nHlUFTEN-e35PT8M0bW4Q", "_sourceName": "vmware", - "host.group": "anemavmware", + "host.group": "sumovmware", "os.type": "windows", "sumo.datasource": "vmware", "_sourceCategory": "otel/vmware", - "deployment.environment": "anemavmware", + "deployment.environment": "sumovmware", "_contentType": "OpenTelemetry", "host.name": "WIN-U8TUICHO2JM", "metric": "vcenter.host.cpu.utilization", From 60ddb825a4ef2f4adcfe076bb4f395cba13ecf40 Mon Sep 17 00:00:00 2001 From: John Pipkin Date: Tue, 23 Jul 2024 10:53:52 -0500 Subject: [PATCH 04/13] Fix build error --- .../databases/opentelemetry/cassandra-opentelemetry.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index 081000fcfb..c822d3cf8b 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -138,6 +138,8 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; ``` ## Sample metric message + +```json { "queryId": "A", "_source": "cassandra-otel", @@ -170,6 +172,7 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; "latest": 67, "count": 4 } +``` ## Sample Log queries  From 2656aa7240977ec95fb351e5acbb2103e1fe303c Mon Sep 17 00:00:00 2001 From: Alekh Nema Date: Wed, 24 Jul 2024 11:16:30 +0530 Subject: [PATCH 05/13] removing cassandra otel doc update which was mistakenly updated in this branch --- .../opentelemetry/cassandra-opentelemetry.md | 274 ------------------ 1 file changed, 274 deletions(-) delete mode 100644 docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md deleted file mode 100644 index 081000fcfb..0000000000 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ /dev/null @@ -1,274 +0,0 @@ ---- -id: cassandra-opentelemetry -title: Cassandra - OpenTelemetry Collector -sidebar_label: Cassandra - OTel Collector -description: Learn about the Sumo Logic OpenTelemetry App for Cassandra. ---- - -import useBaseUrl from '@docusaurus/useBaseUrl'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Thumbnail icon Thumbnail icon - -The [Cassandra](https://cassandra.apache.org/_/cassandra-basics.html) - OpenTelemetry app is a log and metric based app that helps you monitor the availability, performance, health, and resource utilization of your Cassandra clusters. Preconfigured dashboards provide insight into resource utilization, cache/Gossip/Memtable statistics and Error and warnings along with the request served and latency, storage and compaction related metrics. Cassandra logs are sent to Sumo Logic through OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) and cassandra metrics are sent to Sumo Logic using [JMX opentelemetry receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) with the `target_system` set as [`cassandra`](https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/docs/target-systems/cassandra.md) - -The app supports Logs from the open-source version of Cassandra. The App is tested on the 4.0.0 version of Cassandra. - -Schematics - -## Fields creation in Sumo Logic for Cassandra - -Following are the [Fields](/docs/manage/fields/) which will be created as part of Cassandra App install if not already present: - -- `deployment.environment`. User configured. Through this Cassandra cluster is identified by the environment where it resides. For example: dev, prod or qa. -- `db.cluster.name`. User configured. Enter a name to identify this Cassandra cluster. This cluster name will be shown in the Sumo Logic dashboards. -- `db.system`. Has fixed value of **cassandra**. -- `db.node.name`. Holds the value of the Fully Qualified Domain Name (FQDN) of the machine from which the OpenTelemetry collector is collecting logs and metrics. -- `sumo.datasource`. Has fixed value of **cassandra**. - -## Prerequisites - -#### For metric collection - -JMX receiver collects Cassandra metrics from Cassandra server as part of the OpenTelemetry Collector (OTC). - - 1. Follow the instructions in [JMX - OpenTelemetry's prerequisites section](/docs/integrations/app-development/opentelemetry/jmx-opentelemetry/#prerequisites) to download the [JMX Metric Gatherer](https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/README.md). This gatherer is used by the [JMX Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver#details). - - 2. Set the JMX port by setting it as part of `JAVA_OPTS` for Tomcat startup. Usually it is set in the `/etc/systemd/system/cassandra.service` or `C:\Program Files\apache-tomcat\bin\tomcat.bat` file. - - ```json - JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=11099 -Dcom.sun.management.jmxremote.authenticate=true -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.password.file=${CASSANDRA_CONF_DIR}/jmx.password -Dcom.sun.management.jmxremote.access.file=${CASSANDRA_CONF_DIR}/jmx.access" - ``` - -#### For log collection -Cassandra has three main logs: system.log, debug.log, and gc.log which hold general logging messages, debugging logging messages, and java garbage collection logs respectively. - -These logs by default live in `${CASSANDRA_HOME}/logs`, but most Linux distributions relocate logs to `/var/log/cassandra`. Operators can tune this location as well as what levels are logged using the provided logback.xml file. For more details on Cassandra logs, see[ this](https://cassandra.apache.org/doc/latest/troubleshooting/reading_logs.html) link. - -import LogsCollectionPrereqisites from '../../../reuse/apps/logs-collection-prereqisites.md'; - - - -## Collection configuration and app installation - -import ConfigAppInstall from '../../../reuse/apps/opentelemetry/config-app-install.md'; - - - -### Step 1: Set up Collector - -import SetupColl from '../../../reuse/apps/opentelemetry/set-up-collector.md'; - - - -Collector - -### Step 2: Configure integration - -In this step, you will configure the yaml required for Cassandra Collection. Path of the log file configured to capture Cassandra logs needs to be given here. - -Below are the inputs required: -- The path to system.log is required here. This file is typically located in `/var/log/cassandra`. If you're using a customized path, check the respective conf file for this information. -- For metrics, you're required to provide the JMX endpoint (default is `localhost:7199`) along with the `collection_interval` (default is 1 minute). - -You can add any custom fields which you want to be tagged with the data ingested in Sumo. Click on the **Download YAML File** button to get the yaml file. - -YAML - -### Step 3: Send logs to Sumo - -import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; - - - - - - - - 1. Copy the yaml to `/etc/otelcol-sumo/conf.d/` folder for the Cassandra instance which needs to be monitored. - 2. Restart the collector using: - ```sh -  sudo systemctl restart otelcol-sumo - ``` - - - - - -import ChefNoEnv from '../../../reuse/apps/opentelemetry/chef-without-env.md'; - - - - - - - -import AnsibleNoEnv from '../../../reuse/apps/opentelemetry/ansible-without-env.md'; - - - - - - - -import PuppetNoEnv from '../../../reuse/apps/opentelemetry/puppet-without-env.md'; - - - - - - -import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; - - - -## Sample log messages - -```sql - INFO [ScheduledTasks:1] 2023-01-08 09:18:47,347 StatusLogger.java:101 - system.schema_aggregates -``` - -## Sample metric message -{ - "queryId": "A", - "_source": "cassandra-otel", - "_metricId": "dasIFS6RvCVxEcsljWGpnQ", - "_sourceName": "Http Input", - "host.id": "i-071ade75d03650657", - "host.group": "cassandraHostGrp", - "telemetry.sdk.version": "1.38.0", - "os.type": "linux", - "sumo.datasource": "cassandra", - "db.system": "cassandra", - "db.node.name": "ip-54-163-607-30.ec2.internal", - "_sourceCategory": "Labs/cassandra-otel", - "deployment.environment": "dev", - "_contentType": "Carbon2", - "host.name": "ip-54-163-607-30.ec2.internal", - "metric": "cassandra.client.request.write.latency.50p", - "_collectorId": "000000000FB3B451", - "_sourceId": "000000005A60F624", - "unit": "us", - "db.cluster.name": "cassandra_cluster", - "telemetry.sdk.language": "java", - "telemetry.sdk.name": "opentelemetry", - "service.name": "unknown_service:java", - "_collector": "Labs - cassandra-otel", - "max": 229, - "min": 0, - "avg": 131.25, - "sum": 525, - "latest": 67, - "count": 4 -} - -## Sample Log queries  - -Following is the query from Cassandra App's overview Dashboard's Nodes Up Panel: - -```sql -%"sumo.datasource"=cassandra %"deployment.environment"=* %"db.cluster.name"=*   "INFO" | json "log" as _rawlog nodrop  -| if (isEmpty(_rawlog), _raw, _rawlog) as _raw -| parse regex field=_raw "(?[A-Z]*) *\[(?[^\]]*?)[:_-]?(?[0-9]*)\] (?.{10} .{12}) *(?[^:]*):(?[0-9]*) - (?.*)" -| if (message matches "InetAddress * is now UP",1,0) as UP -| timeslice 1d -| sum(UP) as UP by _timeslice -| sort by _timeslice asc -``` - -## Sample Metrics queries  -Following is the query from Cassandra App's overview Dashboard's Number of Requests Panel: - -```sql -sumo.datasource=cassandra deployment.environment=* db.cluster.name=* db.node.name=* metric=cassandra.client.request.count | sum -``` - -## Viewing Cassandra Dashboards - -### Overview - -The **Cassandra - Overview** dashboard provides an at-a-glance view of Cassandra backend and frontend HTTP error codes percentage, visitor location, URLs, and clients causing errors. - -Use this dashboard to: - -- Identify number of nodes which are up and down -- Gain insights into Memory - Init, used, Max and committed -- Gain insights into the error and warning logs by thread and Node activity - -Collector - -### Cache Stats - -The **Cassandra - Cache Stats** dashboard provides insight into the database cache status, schedule, and items. - -Use this dashboard to: - -- Monitor Cache performance. -- Identify Cache usage statistics. - -Cache Stats - -### Errors and Warnings - -The **Cassandra - Errors and Warnings** dashboard provides details of the database errors and warnings. - -Use this dashboard to: - -- Review errors and warnings generated by the server. -- Review the Threads errors and warning events. - -Errors and Warnings - -### Gossip - -The **Cassandra - Gossip** dashboard provides details about communication between various cassandra nodes. - -Use this dashboard to: - -- Determine nodes with errors resulting in failures. -- Review the node activity and pending tasks. - -Gossip - -### Memtable - -The **Cassandra - Memtable** dashboard provides insights into memtable statistics. - -Use this dashboard to: - -- Review flush activity and memtable status. - -Memtable - -### Resource Usage - -The **Cassandra - Resource Usage** dashboard provides details of resource utilization across Cassandra clusters. - -Use this dashboard to: - -- Identify resource utilization. This can help you to determine whether resources are over-allocated or under-allocated. - -Resource Usage - -### Compaction - -The Cassandra - Compactions dashboard provides a insight into the completed and pending compaction tasks. -Compaction - -### Requests -The Cassandra - Requests dashboard gives insight into the number of request served, number of error request and their distribution by status and operation. Also you can monitor the read and write latency of the cluster instance using this dashboard. -Requests - -### Storage -The Cassandra - Storage dashboard provides insight into the current value of total hints of your cassandra cluster along with storage managed by the cluster. - -Storage \ No newline at end of file From 17b2187047c9bac0567c85bd6a610ba948a49ab7 Mon Sep 17 00:00:00 2001 From: Alekh Nema Date: Wed, 24 Jul 2024 11:20:52 +0530 Subject: [PATCH 06/13] Cassandra file was deleted but had to be replaced with the old change. --- .../opentelemetry/cassandra-opentelemetry.md | 204 ++++++++++++++++++ 1 file changed, 204 insertions(+) create mode 100644 docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md new file mode 100644 index 0000000000..681ba3a7cd --- /dev/null +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -0,0 +1,204 @@ +--- +id: cassandra-opentelemetry +title: Cassandra - OpenTelemetry Collector +sidebar_label: Cassandra - OTel Collector +description: Learn about the Sumo Logic OpenTelemetry App for Cassandra. +--- + +import useBaseUrl from '@docusaurus/useBaseUrl'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Thumbnail icon Thumbnail icon + +The [Cassandra](https://cassandra.apache.org/_/cassandra-basics.html) - OpenTelemetry app is a log based app that helps you monitor the availability, performance, health, and resource utilization of your Cassandra clusters. Preconfigured dashboards provide insight into resource utilization, cache/Gossip/Memtable statistics and Error and warnings. Cassandra logs are sent to Sumo Logic through OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver). + +The app supports Logs from the open-source version of Cassandra. The App is tested on the 3.11.10 version of Cassandra. + +Schematics + +## Fields creation in Sumo Logic for Cassandra + +Following are the [Fields](/docs/manage/fields/) which will be created as part of Cassandra App install if not already present: + +- `db.cluster.name`. User configured. Enter a name to identify this Cassandra cluster. This cluster name will be shown in the Sumo Logic dashboards. +- `db.system`. Has fixed value of **cassandra**. +- `deployment.environment`. User configured. Through this Cassandra cluster is identified by the environment where it resides. For example: dev, prod or qa. +- `sumo.datasource`. Has fixed value of **cassandra**. + +## Prerequisites + +Cassandra has three main logs: system.log, debug.log, and gc.log which hold general logging messages, debugging logging messages, and java garbage collection logs respectively. + +These logs by default live in `${CASSANDRA_HOME}/logs`, but most Linux distributions relocate logs to `/var/log/cassandra`. Operators can tune this location as well as what levels are logged using the provided logback.xml file. For more details on Cassandra logs, see[ this](https://cassandra.apache.org/doc/latest/troubleshooting/reading_logs.html) link. + +import LogsCollectionPrereqisites from '../../../reuse/apps/logs-collection-prereqisites.md'; + + + +## Collection configuration and app installation + +import ConfigAppInstall from '../../../reuse/apps/opentelemetry/config-app-install.md'; + + + +### Step 1: Set up Collector + +import SetupColl from '../../../reuse/apps/opentelemetry/set-up-collector.md'; + + + +Collector + +### Step 2: Configure integration + +In this step, you will configure the yaml required for Cassandra Collection. Path of the log file configured to capture Cassandra logs needs to be given here. + +Below are the inputs required: +- The path to system.log is required here. This file is typically located in `/var/log/cassandra`. If you're using a customized path, check the respective conf file for this information. + +You can add any custom fields which you want to be tagged with the data ingested in Sumo. Click on the **Download YAML File** button to get the yaml file. + +YAML + +### Step 3: Send logs to Sumo + +import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; + + + + + + + + 1. Copy the yaml to `/etc/otelcol-sumo/conf.d/` folder for the Cassandra instance which needs to be monitored. + 2. Restart the collector using: + ```sh + sudo systemctl restart otelcol-sumo + ``` + + + + + +import ChefNoEnv from '../../../reuse/apps/opentelemetry/chef-without-env.md'; + + + + + + + +import AnsibleNoEnv from '../../../reuse/apps/opentelemetry/ansible-without-env.md'; + + + + + + + +import PuppetNoEnv from '../../../reuse/apps/opentelemetry/puppet-without-env.md'; + + + + + + +import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; + + + +## Sample log messages + +```sql + INFO [ScheduledTasks:1] 2023-01-08 09:18:47,347 StatusLogger.java:101 - system.schema_aggregates +``` + +## Sample queries + +Following is the query from Cassandra App's overview Dashboard's Nodes Up Panel: + +```sql +%"sumo.datasource"=cassandra %"deployment.environment"=* %"db.cluster.name"=* "INFO" | json "log" as _rawlog nodrop +| if (isEmpty(_rawlog), _raw, _rawlog) as _raw +| parse regex field=_raw "(?[A-Z]*) *\[(?[^\]]*?)[:_-]?(?[0-9]*)\] (?.{10} .{12}) *(?[^:]*):(?[0-9]*) - (?.*)" +| if (message matches "InetAddress * is now UP",1,0) as UP +| timeslice 1d +| sum(UP) as UP by _timeslice +| sort by _timeslice asc +``` + +## Viewing Cassandra Dashboards + +### Overview + +The **Cassandra - Overview** dashboard provides an at-a-glance view of Cassandra backend and frontend HTTP error codes percentage, visitor location, URLs, and clients causing errors. + +Use this dashboard to: + +- Identify number of nodes which are up and down +- Gain insights into Memory - Init, used, Max and committed +- Gain insights into the error and warning logs by thread and Node activity + +Collector + +### Cache Stats + +The **Cassandra - Cache Stats** dashboard provides insight into the database cache status, schedule, and items. + +Use this dashboard to: + +- Monitor Cache performance. +- Identify Cache usage statistics. + +Cache Stats + +### Errors and Warnings + +The **Cassandra - Errors and Warnings** dashboard provides details of the database errors and warnings. + +Use this dashboard to: + +- Review errors and warnings generated by the server. +- Review the Threads errors and warning events. + +Errors and Warnings + +### Gossip + +The **Cassandra - Gossip** dashboard provides details about communication between various cassandra nodes. + +Use this dashboard to: + +- Determine nodes with errors resulting in failures. +- Review the node activity and pending tasks. + +Gossip + +### Memtable + +The **Cassandra - Memtable** dashboard provides insights into memtable statistics. + +Use this dashboard to: + +- Review flush activity and memtable status. + +Memtable + +### Resource Usage + +The **Cassandra - Resource Usage** dashboard provides details of resource utilization across Cassandra clusters. + +Use this dashboard to: + +- Identify resource utilization. This can help you to determine whether resources are over-allocated or under-allocated. + +Resource Usage \ No newline at end of file From 8439bf86c627e37e11d49ab65b1579e0c62e74a8 Mon Sep 17 00:00:00 2001 From: Alekh Nema <91047769+sumoanema@users.noreply.github.com> Date: Thu, 25 Jul 2024 10:49:46 +0530 Subject: [PATCH 07/13] Apply suggestions from code review Co-authored-by: John Pipkin (Sumo Logic) --- .../opentelemetry/vmware-opentelemetry.md | 44 +++++++++---------- 1 file changed, 21 insertions(+), 23 deletions(-) diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md index ef7ae95f04..4da6d602c8 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -11,9 +11,9 @@ import TabItem from '@theme/TabItem'; VMware dashboards -The VMware - OpenTelemetry app uses metrics from the VMware cloud computing virtualisation platform to enable monitoring of vCenter, datacenter, resource pool, cluster, ESXi hosts and individual virtual machines metrics with real-time date displayed in predefined dashboards. +The VMware - OpenTelemetry app uses metrics from the VMware cloud computing virtualization platform to enable monitoring of vCenter, datacenter, resource pool, cluster, ESXi hosts, and individual virtual machine metrics with real-time data displayed in predefined dashboards. -The dashboards provide insight into key metrics such as CPU, memory, disk utilization at different infrastructure level like vm, host, datacenter, resource pool and clusters. This enables you to determine capacity constraints and troubleshoot operational issues related to over-provisioning, changes to configuration, and VM movement. +The dashboards provide insight into key metrics such as CPU, memory, disk utilization at different infrastructure levels like VM, host, datacenter, resource pool, and clusters. This enables you to determine capacity constraints and troubleshoot operational issues related to over-provisioning, changes to configuration, and VM movement. VMWare metrics are collected through the [vCenter Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/vcenterreceiver) of OpenTelemetry. @@ -29,7 +29,7 @@ This receiver has been built to support ESXi and vCenter versions: - 8 - 7.0 -A “Read Only” user assigned to a vSphere with permissions to the vCenter server, cluster and all subsequent resources being monitored must be specified in order for the receiver to retrieve information about them. +A “Read Only” user assigned to a vSphere with permissions to the vCenter server, cluster, and all subsequent resources being monitored must be specified in order for the receiver to retrieve information about them. ## Collection configuration and app installation @@ -47,16 +47,14 @@ import SetupColl from '../../../reuse/apps/opentelemetry/set-up-collector.md'; ### Step 2: Configure integration -In this step, we will be configuring the yaml file required for VMWare Collection. Here are the list of parameters which are required: +In this step, we will be configuring the YAML file required for VMWare Collection. Here is the list of parameters which are required: -- **Endpoint** to the vCenter Server or ESXi host that has the sdk path enabled. This is a required parameter. The expected format is `://` - -i.e: `https://vcsa.hostname.localnet` -- **Username** of User which has access to vcenter server -- **Password** of User which has access to vcenter server +- **Endpoint** to the vCenter Server or ESXi host that has the SDK path enabled. This is a required parameter. The expected format is `://`. For example, `https://vcsa.hostname.localnet`. +- **Username** of User which has access to vCenter server +- **Password** of User which has access to vCenter server - **collection_interval** this receiver collects metrics on an interval. If the vCenter is fairly large, this value may need to be increased. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h` -You can add any custom fields which you want to tag along with the data ingested in sumo. Click on the **Download YAML File** button to get the yaml file. +You can add any custom fields which you want to tag along with the data ingested in Sumo Logic. Click on the **Download YAML File** button to get the YAML file. For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. @@ -91,7 +89,7 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; -1. Copy the yaml file to `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\conf.d` folder in the VMWare instance which has access to vCenter or the vCenter itself. +1. Copy the YAML file to `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\conf.d` folder in the VMWare instance which has access to vCenter or the vCenter itself. 2. Restart the collector using: ```sh Restart-Service -Name OtelcolSumo @@ -100,7 +98,7 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; -1. Copy the yaml file to /etc/otelcol-sumo/conf.d/ folder in the VMWare instance which has access to vCenter or the vCenter itself. +1. Copy the YAML file to /etc/otelcol-sumo/conf.d/ folder in the VMWare instance which has access to vCenter or the vCenter itself. 2. Restart the otelcol-sumo process using the below command  ```sh  otelcol-sumo --config /etc/otelcol-sumo/sumologic.yaml --config "glob:/etc/otelcol-sumo/conf.d/*.yaml"  @@ -191,13 +189,13 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n - **Number of ESXi Hosts in Cluster**. The total number of ESXi hosts in the cluster. - **Number of VMs in Cluster**. The total number of VMs in the cluster. - **Available Cluster Memory**. Percentage of memory available in the cluster. -- **Available Cluster CPU**. Percentage of cpu available in the cluster. +- **Available Cluster CPU**. Percentage of CPU available in the cluster. - **Datastore Disk Utilization**. The disk utilization of the datastore. - **VM Disk Usage**. The disk usage of VM. -- **Top 25 ESXi Hosts CPU Utilization**. Top 25 ESXi Hosts cpu utilization. +- **Top 25 ESXi Hosts CPU Utilization**. Top 25 ESXi Hosts CPU utilization. - **Top 25 ESXi Hosts Memory Utilization**. Top 25 ESXi Hosts memory utilization. - **Top 25 ESXi Hosts Network Usage**. Top 25 ESXi Hosts usage. -- **Top 25 VMs CPU Utilization**. Top 25 VMs cpu utilization. +- **Top 25 VMs CPU Utilization**. Top 25 VMs CPU utilization. - **Top 25 VMs Memory Utilization**. Top 25 VMs memory utilization. - **Top 25 VMs Network Usage**. Top 25 VMs network usage. - **Top 25 VMs Memory Ballooning**. Top 25 VMs memory ballooning. @@ -224,11 +222,11 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n VMWare-Host-Overview-Details -- **Top 25 ESXi Hosts CPU Utilization**. Top 25 ESXi Hosts cpu utilization. +- **Top 25 ESXi Hosts CPU Utilization**. Top 25 ESXi Hosts CPU utilization. - **Top 25 ESXi Hosts Memory Utilization**. Top 25 ESXi Hosts memory utilization. - **Top 25 ESXi Hosts Network Usage**. Top 25 ESXi Hosts usage. - **Top 25 ESXi Hosts Disk Read/ Write Latency**. Top 25 ESXi Hosts disk read/ write latency. -- **Top 25 ESXi Hosts CPU Usage**. Top 25 ESXi Hosts cpu usage. +- **Top 25 ESXi Hosts CPU Usage**. Top 25 ESXi Hosts CPU usage. - **Top 25 ESXi Hosts Disk Read/ Write Rate**. Top 25 ESXi Hosts disk read/ write rate. - **Top 25 ESXi Hosts Network Throughput**. Top 25 ESXi Hosts network throughput. - **Top 25 ESXi Hosts Network Packet Rate**. Top 25 ESXi Hosts network transmitted/ received packet rate. @@ -238,17 +236,17 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n VMWare-VM-Overview-Details -- **Top 25 VMs CPU Utilization**. Top 25 VMs cpu utilization. +- **Top 25 VMs CPU Utilization**. Top 25 VMs CPU utilization. - **Top 25 VMs Memory Utilization**. Top 25 VMs memory utilization. - **Top 25 VMs Disk Utilization**. Top 25 VMs disk utilization. - **Top 25 VMs Network Usage**. Top 25 VMs network usage. - **Top 25 VMs Disk Usage**. Top 25 VMs disk usage. -- **Top 25 VMs CPU Usage**. Top 25 VMs cpu usage. +- **Top 25 VMs CPU Usage**. Top 25 VMs CPU usage. - **Top 25 VMs Memory Usage**. Top 25 VMs memory usage. - **Top 25 VMs Memory Ballooning**. Top 25 VMs memory ballooning. -- **Top 25 VMs Disk Read/ Write Latency**. Top 25 VMs disk read/ write latency. -- **Top 25 VMs Disk Read/ Write Rate**. Top 25 VMs disk read/ write rate. +- **Top 25 VMs Disk Read/ Write Latency**. Top 25 VMs disk read/write latency. +- **Top 25 VMs Disk Read/ Write Rate**. Top 25 VMs disk read/write rate. - **Top 25 VMs Network Throughput**. Top 25 VMs network throughput. -- **Top 25 VMs Network Packet Rate**. Top 25 VMs network transmitted/ received packet rate. -- **Top 25 VMs Network Packet Drop Rate**. Top 25 VMs network transmitted/ received packet drop rate. +- **Top 25 VMs Network Packet Rate**. Top 25 VMs network transmitted/received packet rate. +- **Top 25 VMs Network Packet Drop Rate**. Top 25 VMs network transmitted/received packet drop rate. - **Top 25 VMs Memory Swapped**. Top 25 VMs memory swapped. From 2c615d02adc08220fbbc30179baf4ff01b751c55 Mon Sep 17 00:00:00 2001 From: Ankur Chaudhary Date: Thu, 25 Jul 2024 16:01:52 +0530 Subject: [PATCH 08/13] updated s3 urls in src and resolved PR comments --- .../opentelemetry/vmware-opentelemetry.md | 66 +++++++++++-------- 1 file changed, 39 insertions(+), 27 deletions(-) diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md index 4da6d602c8..eba3159cd4 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -184,7 +184,7 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n ### VMWare - Overview -VMWare-Overview +VMWare-Overview - **Number of ESXi Hosts in Cluster**. The total number of ESXi hosts in the cluster. - **Number of VMs in Cluster**. The total number of VMs in the cluster. @@ -202,7 +202,7 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n ### VMWare - Clusters -VMWare-Clusters +VMWare-Clusters - **Number of ESXi Hosts in Cluster**. The total number of ESXi hosts in the cluster. - **Number of VMs in Cluster**. The total number of VMs in the cluster. @@ -211,42 +211,54 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n ### VMWare - Resource Pools -VMWare-Resource-Pools +VMWare-Resource-Pools - **Cluster CPU Usage**. CPU usage of the resource pool. - **Cluster Memory Usage**. Memory usage of the resource pool. - **Shares of CPU**. Shares of CPU in the resource pool. - **Shares of Memory**. Shares of Memory in the resource pool. -### VMWare - Host Overview/ Details +### VMWare - Host Overview -VMWare-Host-Overview-Details +VMWare-Host-Overview-Details + +- **Top 25 ESXi Hosts CPU Utilization**. Top 25 ESXi Hosts CPU Utilization. +- **Top 25 ESXi Hosts Memory Utilization**. Top 25 ESXi Hosts Memory Utilization. +- **Top 25 ESXi Hosts Network Usage**. Top 25 ESXi Hosts Network Usage. +- **Top 25 ESXi Hosts Disk Read/ Write Latency**. Top 25 ESXi Hosts Disk read/ write latency. + +### VMWare - Host Details + +VMWare-Host-Overview-Details -- **Top 25 ESXi Hosts CPU Utilization**. Top 25 ESXi Hosts CPU utilization. -- **Top 25 ESXi Hosts Memory Utilization**. Top 25 ESXi Hosts memory utilization. -- **Top 25 ESXi Hosts Network Usage**. Top 25 ESXi Hosts usage. -- **Top 25 ESXi Hosts Disk Read/ Write Latency**. Top 25 ESXi Hosts disk read/ write latency. - **Top 25 ESXi Hosts CPU Usage**. Top 25 ESXi Hosts CPU usage. -- **Top 25 ESXi Hosts Disk Read/ Write Rate**. Top 25 ESXi Hosts disk read/ write rate. -- **Top 25 ESXi Hosts Network Throughput**. Top 25 ESXi Hosts network throughput. -- **Top 25 ESXi Hosts Network Packet Rate**. Top 25 ESXi Hosts network transmitted/ received packet rate. -- **Top 25 ESXi Hosts Network Packet Error Rate**. Top 25 ESXi Hosts network transmitted/ received packet error rate. +- **Top 25 ESXi Hosts Disk Read/ Write Rate**. Top 25 ESXi Hosts Disk read/ write rate. +- **Top 25 ESXi Hosts Network Throughput**. Top 25 ESXi Hosts Network throughput. +- **Top 25 ESXi Hosts Network Packet Rate**. Top 25 ESXi Hosts Network transmitted/ received packet rate. +- **Top 25 ESXi Hosts Network Packet Error Rate**. Top 25 ESXi Hosts Network transmitted/ received packet error rate. -### VMWare - VM Overview/ Details +### VMWare - VM Overview -VMWare-VM-Overview-Details +VMWare-VM-Overview-Details - **Top 25 VMs CPU Utilization**. Top 25 VMs CPU utilization. -- **Top 25 VMs Memory Utilization**. Top 25 VMs memory utilization. -- **Top 25 VMs Disk Utilization**. Top 25 VMs disk utilization. -- **Top 25 VMs Network Usage**. Top 25 VMs network usage. -- **Top 25 VMs Disk Usage**. Top 25 VMs disk usage. +- **Top 25 VMs Memory Utilization**. Top 25 VMs Memory utilization. +- **Top 25 VMs Disk Utilization**. Top 25 VMs Disk utilization. +- **Top 25 VMs Network Usage**. Top 25 VMs Network usage. +- **Top 25 VMs Disk Usage**. Top 25 VMs Disk usage. +- **Top 25 VMs Memory Ballooning**. Top 25 VMs Memory Ballooning. + +### VMWare - VM Details + +VMWare-VM-Overview-Details + - **Top 25 VMs CPU Usage**. Top 25 VMs CPU usage. -- **Top 25 VMs Memory Usage**. Top 25 VMs memory usage. -- **Top 25 VMs Memory Ballooning**. Top 25 VMs memory ballooning. -- **Top 25 VMs Disk Read/ Write Latency**. Top 25 VMs disk read/write latency. -- **Top 25 VMs Disk Read/ Write Rate**. Top 25 VMs disk read/write rate. -- **Top 25 VMs Network Throughput**. Top 25 VMs network throughput. -- **Top 25 VMs Network Packet Rate**. Top 25 VMs network transmitted/received packet rate. -- **Top 25 VMs Network Packet Drop Rate**. Top 25 VMs network transmitted/received packet drop rate. -- **Top 25 VMs Memory Swapped**. Top 25 VMs memory swapped. +- **Top 25 VMs Memory Usage**. Top 25 VMs Memory usage. +- **Top 25 VMs Disk Read/ Write Latency**. Top 25 VMs Disk read/write latency. +- **Top 25 VMs Disk Read/ Write Rate**. Top 25 VMs Disk read/write rate. +- **Top 25 VMs Network Throughput**. Top 25 VMs Network throughput. +- **Top 25 VMs Network Packet Rate**. Top 25 VMs Network transmitted/received packet rate. +- **Top 25 VMs Network Packet Drop Rate**. Top 25 VMs Network transmitted/received packet drop rate. +- **Top 25 VMs Memory Swapped**. Top 25 VMs Memory swapped. + +s3://sumologic-app-data-v2/dashboards/VMWare-OpenTelemetry/VMware-VM-Details.png From ca2ab0680000ddd21f170c2ee1dc5e05745e712b Mon Sep 17 00:00:00 2001 From: Ankur Chaudhary Date: Thu, 25 Jul 2024 16:09:58 +0530 Subject: [PATCH 09/13] resolved PR comment - added description for each dashboard --- .../opentelemetry/vmware-opentelemetry.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md index eba3159cd4..adfc853f57 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -182,8 +182,12 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n ## Viewing VMWare dashboards +**Filters with Template Variables**: Template variables provide dynamic dashboards that rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you can view dynamic changes to the data for a fast resolution to the root cause. For more information, see [Filter with template variables](/docs/dashboards/filter-template-variables/). + ### VMWare - Overview +The **VMWare - Overview** dashboard provides an at-a-glance view of unique clusters, ESXi hosts, unique VMs. It also provides data for datastore disk utilisation, VM disk usage, CPU Utilisation, Memory Utilisation, Network Usage for VM and Hosts. + VMWare-Overview - **Number of ESXi Hosts in Cluster**. The total number of ESXi hosts in the cluster. @@ -202,6 +206,8 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n ### VMWare - Clusters +The **VMWare - Clusters** dashboard provides at-a-glance analysis of VMWare cluster metrics like Hosts count, VM count, available CPU and Memory percentage. + VMWare-Clusters - **Number of ESXi Hosts in Cluster**. The total number of ESXi hosts in the cluster. @@ -211,6 +217,8 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n ### VMWare - Resource Pools +The **VMWare - Resource Pools** dashboard provides at-a-glance analysis of Resource Pool metrics like Memory Usage, CPU Usage, Shares of CPU and Memory. + VMWare-Resource-Pools - **Cluster CPU Usage**. CPU usage of the resource pool. @@ -220,6 +228,8 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n ### VMWare - Host Overview +The **VMWare - Host Overview** dashboard provides at-a-glance analysis of ESXi Hosts metrics lke CPU Utilisation, Memory Utilisation, Read/ Write Latency, Network Usage. + VMWare-Host-Overview-Details - **Top 25 ESXi Hosts CPU Utilization**. Top 25 ESXi Hosts CPU Utilization. @@ -229,6 +239,8 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n ### VMWare - Host Details +The **VMWare - Host Details** dashboard provides detailed analysis of ESXi Hosts metrics like CPU Usage, Memory Usage, Disk Read/ Write Rate, Network Usage, Network Packet Rate, Network Packet Error Rate. + VMWare-Host-Overview-Details - **Top 25 ESXi Hosts CPU Usage**. Top 25 ESXi Hosts CPU usage. @@ -239,6 +251,8 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n ### VMWare - VM Overview +The **VMWare - VM Overview** dashboard provides at-a-glance analysis of VM metrics like CPU Utilisation, Memory Utilisation, Disk Utilisation, Network Usage, Disk Usage. + VMWare-VM-Overview-Details - **Top 25 VMs CPU Utilization**. Top 25 VMs CPU utilization. @@ -250,6 +264,8 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n ### VMWare - VM Details +The **VMWare - VM Details** dashboard provides detailed analysis of VM metrics like CPU Usage, Memory Usage, Read/Write Latency, Network Packet Rate, Memory Swapped. + VMWare-VM-Overview-Details - **Top 25 VMs CPU Usage**. Top 25 VMs CPU usage. @@ -260,5 +276,3 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n - **Top 25 VMs Network Packet Rate**. Top 25 VMs Network transmitted/received packet rate. - **Top 25 VMs Network Packet Drop Rate**. Top 25 VMs Network transmitted/received packet drop rate. - **Top 25 VMs Memory Swapped**. Top 25 VMs Memory swapped. - -s3://sumologic-app-data-v2/dashboards/VMWare-OpenTelemetry/VMware-VM-Details.png From 0c44820f506b53b376f28548558a410f0a7935cf Mon Sep 17 00:00:00 2001 From: Alekh Nema Date: Thu, 25 Jul 2024 16:15:01 +0530 Subject: [PATCH 10/13] sidebar entry for the new file and type corrections --- .../opentelemetry/vmware-opentelemetry.md | 4 ++-- sidebars.ts | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md index adfc853f57..9dcdd561a8 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -26,7 +26,7 @@ VMWare metrics are collected through the [vCenter Receiver](https://github.com/o This receiver has been built to support ESXi and vCenter versions: -- 8 +- 8.0 - 7.0 A “Read Only” user assigned to a vSphere with permissions to the vCenter server, cluster, and all subsequent resources being monitored must be specified in order for the receiver to retrieve information about them. @@ -228,7 +228,7 @@ The **VMWare - Resource Pools** dashboard provides at-a-glance analysis of Resou ### VMWare - Host Overview -The **VMWare - Host Overview** dashboard provides at-a-glance analysis of ESXi Hosts metrics lke CPU Utilisation, Memory Utilisation, Read/ Write Latency, Network Usage. +The **VMWare - Host Overview** dashboard provides at-a-glance analysis of ESXi Hosts metrics like CPU Utilisation, Memory Utilisation, Read/ Write Latency, Network Usage. VMWare-Host-Overview-Details diff --git a/sidebars.ts b/sidebars.ts index 81dc449c1f..c9ee347a00 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -2110,6 +2110,7 @@ integrations: [ 'integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry', 'integrations/containers-orchestration/opentelemetry/kafka-opentelemetry', 'integrations/containers-orchestration/opentelemetry/activemq-opentelemetry', + 'integrations/containers-orchestration/opentelemetry/vmware-opentelemetry' ], }, 'integrations/containers-orchestration/activemq', From 5b782b6d9208a68493edee7c0e6f8d27e2b7f3f0 Mon Sep 17 00:00:00 2001 From: John Pipkin Date: Thu, 25 Jul 2024 08:55:24 -0500 Subject: [PATCH 11/13] Updates from review --- .../opentelemetry/vmware-opentelemetry.md | 38 +++++++++---------- .../apps/opentelemetry/send-logs-intro.md | 2 +- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md index 9dcdd561a8..f59ff2546c 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -56,7 +56,7 @@ In this step, we will be configuring the YAML file required for VMWare Collectio You can add any custom fields which you want to tag along with the data ingested in Sumo Logic. Click on the **Download YAML File** button to get the YAML file. -For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. +For the Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. YAML @@ -80,29 +80,29 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; -1. Copy the yaml file to `/etc/otelcol-sumo/conf.d/` folder in the VMWare instance which has access to vCenter or the vCenter itself. +1. Copy the YAML file to `/etc/otelcol-sumo/conf.d/` folder in the VMWare instance which has access to vCenter or the vCenter itself. 2. Restart the collector using: - ```sh -  sudo systemctl restart otelcol-sumo - ``` + ```sh + sudo systemctl restart otelcol-sumo + ``` 1. Copy the YAML file to `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\conf.d` folder in the VMWare instance which has access to vCenter or the vCenter itself. 2. Restart the collector using: - ```sh - Restart-Service -Name OtelcolSumo - ``` + ```sh + Restart-Service -Name OtelcolSumo + ``` 1. Copy the YAML file to /etc/otelcol-sumo/conf.d/ folder in the VMWare instance which has access to vCenter or the vCenter itself. 2. Restart the otelcol-sumo process using the below command  - ```sh -  otelcol-sumo --config /etc/otelcol-sumo/sumologic.yaml --config "glob:/etc/otelcol-sumo/conf.d/*.yaml"  - ``` + ```sh + otelcol-sumo --config /etc/otelcol-sumo/sumologic.yaml --config "glob:/etc/otelcol-sumo/conf.d/*.yaml"  + ``` @@ -182,11 +182,11 @@ sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.n ## Viewing VMWare dashboards -**Filters with Template Variables**: Template variables provide dynamic dashboards that rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you can view dynamic changes to the data for a fast resolution to the root cause. For more information, see [Filter with template variables](/docs/dashboards/filter-template-variables/). +You can filter data on VMWare dashboards with template variables. Template variables provide dynamic dashboards that rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you can view dynamic changes to the data for a fast resolution to the root cause. For more information, see [Filtering Dashboards with Template Variables](/docs/dashboards/filter-template-variables/). ### VMWare - Overview -The **VMWare - Overview** dashboard provides an at-a-glance view of unique clusters, ESXi hosts, unique VMs. It also provides data for datastore disk utilisation, VM disk usage, CPU Utilisation, Memory Utilisation, Network Usage for VM and Hosts. +The **VMWare - Overview** dashboard provides an at-a-glance view of unique clusters, ESXi hosts, and unique VMs. It also provides data for datastore disk utilisation, VM disk usage, CPU Utilization, Memory Utilization, and Network Usage for VMs and Hosts. VMWare-Overview @@ -206,7 +206,7 @@ The **VMWare - Overview** dashboard provides an at-a-glance view of unique clust ### VMWare - Clusters -The **VMWare - Clusters** dashboard provides at-a-glance analysis of VMWare cluster metrics like Hosts count, VM count, available CPU and Memory percentage. +The **VMWare - Clusters** dashboard provides at-a-glance analysis of VMWare cluster metrics like Hosts count, VM count, available CPU, and Memory percentage. VMWare-Clusters @@ -217,7 +217,7 @@ The **VMWare - Clusters** dashboard provides at-a-glance analysis of VMWare clus ### VMWare - Resource Pools -The **VMWare - Resource Pools** dashboard provides at-a-glance analysis of Resource Pool metrics like Memory Usage, CPU Usage, Shares of CPU and Memory. +The **VMWare - Resource Pools** dashboard provides at-a-glance analysis of Resource Pool metrics like Memory Usage, CPU Usage, Shares of CPU, and Memory. VMWare-Resource-Pools @@ -228,7 +228,7 @@ The **VMWare - Resource Pools** dashboard provides at-a-glance analysis of Resou ### VMWare - Host Overview -The **VMWare - Host Overview** dashboard provides at-a-glance analysis of ESXi Hosts metrics like CPU Utilisation, Memory Utilisation, Read/ Write Latency, Network Usage. +The **VMWare - Host Overview** dashboard provides at-a-glance analysis of ESXi Hosts metrics like CPU Utilization, Memory Utilization, Read/ Write Latency, and Network Usage. VMWare-Host-Overview-Details @@ -239,7 +239,7 @@ The **VMWare - Host Overview** dashboard provides at-a-glance analysis of ESXi H ### VMWare - Host Details -The **VMWare - Host Details** dashboard provides detailed analysis of ESXi Hosts metrics like CPU Usage, Memory Usage, Disk Read/ Write Rate, Network Usage, Network Packet Rate, Network Packet Error Rate. +The **VMWare - Host Details** dashboard provides detailed analysis of ESXi Hosts metrics like CPU Usage, Memory Usage, Disk Read/ Write Rate, Network Usage, Network Packet Rate, and Network Packet Error Rate. VMWare-Host-Overview-Details @@ -251,7 +251,7 @@ The **VMWare - Host Details** dashboard provides detailed analysis of ESXi Hosts ### VMWare - VM Overview -The **VMWare - VM Overview** dashboard provides at-a-glance analysis of VM metrics like CPU Utilisation, Memory Utilisation, Disk Utilisation, Network Usage, Disk Usage. +The **VMWare - VM Overview** dashboard provides at-a-glance analysis of VM metrics like CPU Utilisation, Memory Utilization, Disk Utilization, Network Usage, and Disk Usage. VMWare-VM-Overview-Details @@ -264,7 +264,7 @@ The **VMWare - VM Overview** dashboard provides at-a-glance analysis of VM metri ### VMWare - VM Details -The **VMWare - VM Details** dashboard provides detailed analysis of VM metrics like CPU Usage, Memory Usage, Read/Write Latency, Network Packet Rate, Memory Swapped. +The **VMWare - VM Details** dashboard provides detailed analysis of VM metrics like CPU Usage, Memory Usage, Read/Write Latency, Network Packet Rate, and Memory Swapped. VMWare-VM-Overview-Details diff --git a/docs/reuse/apps/opentelemetry/send-logs-intro.md b/docs/reuse/apps/opentelemetry/send-logs-intro.md index 371d799921..616880d317 100644 --- a/docs/reuse/apps/opentelemetry/send-logs-intro.md +++ b/docs/reuse/apps/opentelemetry/send-logs-intro.md @@ -1 +1 @@ -Once you have downloaded the yaml file as described in the previous step, follow the below steps based on your platform. +Once you have downloaded the YAML file as described in the previous step, follow the below steps based on your platform. From 8e613b5e819a3c67d9cbc439f7c57218f472398e Mon Sep 17 00:00:00 2001 From: Alekh Nema <91047769+sumoanema@users.noreply.github.com> Date: Fri, 26 Jul 2024 11:32:36 +0530 Subject: [PATCH 12/13] Apply suggestions from code review Co-authored-by: Kim (Sumo Logic) <56411016+kimsauce@users.noreply.github.com> --- .../opentelemetry/vmware-opentelemetry.md | 22 +++++++++---------- .../opentelemetry/cassandra-opentelemetry.md | 4 ++-- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md index f59ff2546c..fe7fca26af 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -47,12 +47,12 @@ import SetupColl from '../../../reuse/apps/opentelemetry/set-up-collector.md'; ### Step 2: Configure integration -In this step, we will be configuring the YAML file required for VMWare Collection. Here is the list of parameters which are required: +In this step, we will configure the YAML file required for VMWare Collection. Here is a list of required parameters: - **Endpoint** to the vCenter Server or ESXi host that has the SDK path enabled. This is a required parameter. The expected format is `://`. For example, `https://vcsa.hostname.localnet`. -- **Username** of User which has access to vCenter server -- **Password** of User which has access to vCenter server -- **collection_interval** this receiver collects metrics on an interval. If the vCenter is fairly large, this value may need to be increased. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h` +- **Username** of User which has access to vCenter server. +- **Password** of User which has access to vCenter server. +- **collection_interval** this receiver collects metrics on an interval. If the vCenter is fairly large, this value may need to be increased. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. You can add any custom fields which you want to tag along with the data ingested in Sumo Logic. Click on the **Download YAML File** button to get the YAML file. @@ -80,7 +80,7 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; -1. Copy the YAML file to `/etc/otelcol-sumo/conf.d/` folder in the VMWare instance which has access to vCenter or the vCenter itself. +1. Copy the YAML file to the `/etc/otelcol-sumo/conf.d/` folder on the VMware instance that has access to vCenter or to vCenter itself. 2. Restart the collector using: ```sh sudo systemctl restart otelcol-sumo @@ -98,8 +98,8 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; -1. Copy the YAML file to /etc/otelcol-sumo/conf.d/ folder in the VMWare instance which has access to vCenter or the vCenter itself. -2. Restart the otelcol-sumo process using the below command  +1. Copy the YAML file to `/etc/otelcol-sumo/conf.d/` folder on the VMware instance that has access to vCenter or to vCenter itself. +2. Restart the otelcol-sumo process using the below command: ```sh otelcol-sumo --config /etc/otelcol-sumo/sumologic.yaml --config "glob:/etc/otelcol-sumo/conf.d/*.yaml"  ``` @@ -139,7 +139,7 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; ### Metrics query -This sample Query is from the **VMWare - Overview** > **Top 25 ESXi Hosts - CPU Utilization** panel. +This sample query is from the **VMWare - Overview** > **Top 25 ESXi Hosts - CPU Utilization** panel. ```sql title="Metric query" sumo.datasource=vmware metric=vcenter.host.cpu.utilization vcenter.datacenter.name=* vcenter.cluster.name=* vcenter.host.name=* | topk(25,avg) @@ -217,7 +217,7 @@ The **VMWare - Clusters** dashboard provides at-a-glance analysis of VMWare clus ### VMWare - Resource Pools -The **VMWare - Resource Pools** dashboard provides at-a-glance analysis of Resource Pool metrics like Memory Usage, CPU Usage, Shares of CPU, and Memory. +The **VMWare - Resource Pools** dashboard provides an at-a-glance analysis of Resource Pool metrics like Memory Usage, CPU Usage, Shares of CPU, and Memory. VMWare-Resource-Pools @@ -251,7 +251,7 @@ The **VMWare - Host Details** dashboard provides detailed analysis of ESXi Hosts ### VMWare - VM Overview -The **VMWare - VM Overview** dashboard provides at-a-glance analysis of VM metrics like CPU Utilisation, Memory Utilization, Disk Utilization, Network Usage, and Disk Usage. +The **VMWare - VM Overview** dashboard provides an at-a-glance analysis of VM metrics like CPU Utilization, Memory Utilization, Disk Utilization, Network Usage, and Disk Usage. VMWare-VM-Overview-Details @@ -264,7 +264,7 @@ The **VMWare - VM Overview** dashboard provides at-a-glance analysis of VM metri ### VMWare - VM Details -The **VMWare - VM Details** dashboard provides detailed analysis of VM metrics like CPU Usage, Memory Usage, Read/Write Latency, Network Packet Rate, and Memory Swapped. +The **VMWare - VM Details** dashboard provides a detailed analysis of VM metrics like CPU Usage, Memory Usage, Read/Write Latency, Network Packet Rate, and Memory Swapped. VMWare-VM-Overview-Details diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index 681ba3a7cd..3d6958caa4 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -82,7 +82,7 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; 1. Copy the yaml to `/etc/otelcol-sumo/conf.d/` folder for the Cassandra instance which needs to be monitored. 2. Restart the collector using: ```sh - sudo systemctl restart otelcol-sumo + sudo systemctl restart otelcol-sumo ``` @@ -124,7 +124,7 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; ## Sample queries -Following is the query from Cassandra App's overview Dashboard's Nodes Up Panel: +Following is a query from the Cassandra app's **Cassandra - Overview** dashboard Nodes Up panel: ```sql %"sumo.datasource"=cassandra %"deployment.environment"=* %"db.cluster.name"=* "INFO" | json "log" as _rawlog nodrop From ed133dcb50fad1cdacab0523d14f2d691502c9b7 Mon Sep 17 00:00:00 2001 From: Alekh Nema Date: Mon, 29 Jul 2024 13:13:42 +0530 Subject: [PATCH 13/13] adding entry for cid to the vmware otel doc --- cid-redirects.json | 1 + 1 file changed, 1 insertion(+) diff --git a/cid-redirects.json b/cid-redirects.json index 88e3400e5e..76be3b9045 100644 --- a/cid-redirects.json +++ b/cid-redirects.json @@ -1622,6 +1622,7 @@ "/cid/10171": "/docs/integrations/pci-compliance/palo-alto-networks-10", "/cid/10172": "/docs/integrations/cloud-security-monitoring-analytics/palo-alto-firewall-10", "/cid/10173": "/docs/integrations/amazon-aws/route-53-resolver-security", + "/cid/10174": "/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry", "/cid/1018": "/docs/search/search-query-language/parse-operators/parse-delimited-logs-using-split", "/cid/10180": "/docs/integrations/security-threat-detection/carbon-black-cloud", "/cid/1019": "/docs/search/search-query-language/search-operators/format",