1"use strict";(self.webpackChunksumo_docs=self.webpackChunksumo_docs||[]).push([["12193"],{40911(e,t,s){s.r(t),s.d(t,{metadata:()=>n,default:()=>y,frontMatter:()=>p,contentTitle:()=>g,toc:()=>j,assets:()=>x});var n=JSON.parse('{"id":"integrations/databases/opentelemetry/elasticsearch-opentelemetry","title":"Elasticsearch - OpenTelemetry Collector","description":"Learn about the Sumo Logic OpenTelemetry app for Elasticsearch.","source":"@site/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md","sourceDirName":"integrations/databases/opentelemetry","slug":"/integrations/databases/opentelemetry/elasticsearch-opentelemetry","permalink":"/help/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry","draft":false,"unlisted":false,"editUrl":"https://github.com/SumoLogic/sumologic-documentation/edit/main/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md","tags":[],"version":"current","lastUpdatedBy":"Kim (Sumo Logic)","lastUpdatedAt":1775527689000,"frontMatter":{"id":"elasticsearch-opentelemetry","title":"Elasticsearch - OpenTelemetry Collector","sidebar_label":"Elasticsearch - OTel Collector","description":"Learn about the Sumo Logic OpenTelemetry app for Elasticsearch."},"sidebar":"integrations","previous":{"title":"Couchbase - OTel Collector","permalink":"/help/docs/integrations/databases/opentelemetry/couchbase-opentelemetry"},"next":{"title":"MariaDB - OTel Collector","permalink":"/help/docs/integrations/databases/opentelemetry/mariadb-opentelemetry"}}'),l=s(74848),r=s(28453),a=s(66497);s(50773),s(57250);var o=s(23572),i=s(6232),c=s(44077),d=s(86206),h=s(11429),u=s(38676),m=s(863);let p={id:"elasticsearch-opentelemetry",title:"Elasticsearch - OpenTelemetry Collector",sidebar_label:"Elasticsearch - OTel Collector",description:"Learn about the Sumo Logic OpenTelemetry app for Elasticsearch."},g,x={},j=[{value:"Fields Create in Sumo Logic for Elasticsearch",id:"fields-create-in-sumo-logic-for-elasticsearch",level:2},{value:"Prerequisites",id:"prerequisites",level:2},{value:"For metrics collection",id:"for-metrics-collection",level:3},{value:"For logs collection",id:"for-logs-collection",level:3},...o.RM,{value:"Collection configuration and app installation",id:"collection-configuration-and-app-installation",level:2},{value:"Step 1: Set up remotely managed OpenTelemetry collector",id:"step-1-set-up-remotely-managed-opentelemetry-collector",level:3},...i.RM,{value:"Step 2: Configure the source template",id:"step-2-configure-the-source-template",level:3},...c.RM,...d.RM,...h.RM,{value:"Step 3: Push the source template to the desired remotely managed collectors",id:"step-3-push-the-source-template-to-the-desired-remotely-managed-collectors",level:3},...u.RM,{value:"Sample log messages",id:"sample-log-messages",level:2},{value:"Sample metrics",id:"sample-metrics",level:2},{value:"Sample queries",id:"sample-queries",level:2},{value:"Sample logs query",id:"sample-logs-query",level:3},{value:"Sample metrics query",id:"sample-metrics-query",level:3},{value:"Viewing Elasticsearch dashboards",id:"viewing-elasticsearch-dashboards",level:2},{value:"Overview",id:"overview",level:3},{value:"Total Operations Stats",id:"total-operations-stats",level:3},{value:"Thread Pool",id:"thread-pool",level:3},{value:"Resource",id:"resource",level:3},{value:"Performance Stats",id:"performance-stats",level:3},{value:"Indices",id:"indices",level:3},{value:"Documents",id:"documents",level:3},{value:"Caches",id:"caches",level:3},{value:"Errors And Warnings",id:"errors-and-warnings",level:3},{value:"Garbage Collection",id:"garbage-collection",level:3},{value:"Login And Connections",id:"login-and-connections",level:3},{value:"Operations",id:"operations",level:3},{value:"Queries",id:"queries",level:3},{value:"Create monitors for Elasticsearch app",id:"create-monitors-for-elasticsearch-app",level:2},...m.RM,{value:"Elasticsearch alerts",id:"elasticsearch-alerts",level:3}];function f(e){let t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("img",{src:(0,a.Ay)("img/integrations/databases/elasticsearch.png"),alt:"Elasticsearch icon",width:"50"}),"\n",(0,l.jsx)("img",{src:(0,a.Ay)("img/send-data/otel-color.svg"),alt:"OpenTelemetry color icon",width:"45"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.a,{href:"https://www.elastic.co/what-is/elasticsearch",children:"Elasticsearch"})," app is a unified logs and metrics app that helps you monitor the availability, performance, health, and resource utilization of your Elasticsearch clusters. Preconfigured dashboards provide insight into cluster health, resource utilization, sharding, garbage collection, and search, index, and cache performance."]}),"\n",(0,l.jsx)(t.p,{children:"We use the OpenTelemetry collector to collect Elasticsearch metrics and logs."}),"\n",(0,l.jsxs)(t.p,{children:["The diagram below illustrates the components of the Elasticsearch collection for each database server. OpenTelemetry collector runs on the same host as Elasticsearch, and uses the ",(0,l.jsx)(t.a,{href:"https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/elasticsearchreceiver/",children:"Elasticsearch Receiver"})," to obtain Elasticsearch metrics, and the ",(0,l.jsx)(t.a,{href:"https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter",children:"Sumo Logic OpenTelemetry Exporter"})," to send the metrics to Sumo Logic. Elasticsearch logs are sent to Sumo Logic through a ",(0,l.jsx)(t.a,{href:"https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver",children:"filelog receiver"}),"."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.us-east-1.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Schematics-diagram.png",alt:"Elasticsearch Schematics"}),"\n",(0,l.jsx)(t.admonition,{type:"info",children:(0,l.jsxs)(t.p,{children:["This app includes ",(0,l.jsx)(t.a,{href:"#elasticsearch-alerts",children:"built-in monitors"}),". For details on creating custom monitors, refer to ",(0,l.jsx)(t.a,{href:"#create-monitors-for-elasticsearch-app",children:"Create monitors for Elasticsearch app"}),"."]})}),"\n",(0,l.jsx)(t.h2,{id:"fields-create-in-sumo-logic-for-elasticsearch",children:"Fields Create in Sumo Logic for Elasticsearch"}),"\n",(0,l.jsxs)(t.p,{children:["Following are the ",(0,l.jsx)(t.a,{href:"/docs/manage/fields/",children:"Fields"})," which will be created as part of Elasticsearch app installation, if not already present:"]}),"\n",(0,l.jsxs)(t.ul,{children:["\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"db.cluster.name"}),". User configured. Enter a name to identify this Elasticsearch cluster. This cluster name will be shown in the Sumo Logic dashboards."]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"db.system"}),". Has a fixed value of ",(0,l.jsx)(t.strong,{children:"elasticsearch"}),"."]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"sumo.datasource"}),". Has a fixed value of ",(0,l.jsx)(t.strong,{children:"elasticsearch"}),"."]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.code,{children:"db.node.name"}),". Has the value of host name of the machine which is being monitored."]}),"\n"]}),"\n",(0,l.jsx)(t.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,l.jsx)(t.h3,{id:"for-metrics-collection",children:"For metrics collection"}),"\n",(0,l.jsx)(t.p,{children:"This receiver supports Elasticsearch versions 7.9+."}),"\n",(0,l.jsxs)(t.p,{children:["If Elasticsearch security features are enabled, you must have either the monitor or manage cluster privilege. See the ",(0,l.jsx)(t.a,{href:"https://www.elastic.co/guide/en/elasticsearch/reference/current/authorization.html",children:"Elasticsearch docs"})," for more information on authorization and ",(0,l.jsx)(t.a,{href:"https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html",children:"Security privileges"}),"."]}),"\n",(0,l.jsx)(t.h3,{id:"for-logs-collection",children:"For logs collection"}),"\n",(0,l.jsxs)(t.p,{children:["Elasticsearch supports logging via local text log files. Elasticsearch logs have four levels of verbosity. To select a level, set ",(0,l.jsx)(t.code,{children:"loglevel"})," to one of:"]}),"\n",(0,l.jsxs)(t.ul,{children:["\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.strong,{children:"debug"}),". A lot of information, useful for development/testing."]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.strong,{children:"verbose"}),". Includes information not often needed, but logs less than debug."]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.strong,{children:"notice"})," (default value). Moderately verbose, ideal for production environments."]}),"\n",(0,l.jsxs)(t.li,{children:[(0,l.jsx)(t.strong,{children:"warning"}),". Only important/critical messages are logged."]}),"\n"]}),"\n",(0,l.jsxs)(t.p,{children:["All logging settings are located in ",(0,l.jsx)(t.a,{href:"https://www.elastic.co/guide/en/elasticsearch/reference/current/logging.html",children:"Elasticsearch.conf"}),". By default, Elasticsearch logs are stored in ",(0,l.jsx)(t.code,{children:"/var/log/elasticsearch/ELK-<Clustername>.log"}),". The default directory for log files is listed in the Elasticsearch.conf file."]}),"\n","\n",(0,l.jsx)(o.Ay,{}),"\n",(0,l.jsx)(t.p,{children:"For Windows systems, log files which are collected should be accessible by the SYSTEM group. Use the following set of PowerShell commands if the SYSTEM group does not have access."}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{children:'$NewAcl = Get-Acl -Path "<PATH_TO_LOG_FILE>"\n# Set properties\n$identity = "NT AUTHORITY\\SYSTEM"\n$fileSystemRights = "ReadAndExecute"\n$type = "Allow"\n# Create new rule\n$fileSystemAccessRuleArgumentList = $identity, $fileSystemRights, $type\n$fileSystemAccessRule = New-Object -TypeName System.Security.AccessControl.FileSystemAccessRule -ArgumentList $fileSystemAccessRuleArgumentList\
1n# Apply new rule\n$NewAcl.SetAccessRule($fileSystemAccessRule)\nSet-Acl -Path "<PATH_TO_LOG_FILE>" -AclObject $NewAcl\n'})}),"\n",(0,l.jsx)(t.h2,{id:"collection-configuration-and-app-installation",children:"Collection configuration and app installation"}),"\n",(0,l.jsx)(t.p,{children:"Follow these steps to set up and deploy the source template to collect data in Sumo Logic from a remotely managed OpenTelemetry collector."}),"\n",(0,l.jsx)(t.h3,{id:"step-1-set-up-remotely-managed-opentelemetry-collector",children:"Step 1: Set up remotely managed OpenTelemetry collector"}),"\n","\n",(0,l.jsx)(t.admonition,{type:"note",children:(0,l.jsxs)(t.p,{children:["If you want to configure your source locally, you can do so by downloading the YAML file. For details, see ",(0,l.jsx)(t.a,{href:"/docs/integrations/sumo-apps/opentelemetry-collector-insights/#configure-opentelemetry-collectors-locally",children:"Configure OpenTelemetry collectors locally"}),"."]})}),"\n",(0,l.jsx)(i.Ay,{}),"\n",(0,l.jsx)(t.h3,{id:"step-2-configure-the-source-template",children:"Step 2: Configure the source template"}),"\n","\n",(0,l.jsx)(c.Ay,{}),"\n","\n",(0,l.jsx)(d.Ay,{}),"\n","\n",(0,l.jsx)(h.Ay,{}),"\n",(0,l.jsx)(t.h3,{id:"step-3-push-the-source-template-to-the-desired-remotely-managed-collectors",children:"Step 3: Push the source template to the desired remotely managed collectors"}),"\n","\n",(0,l.jsx)(u.Ay,{}),"\n",(0,l.jsx)(t.h2,{id:"sample-log-messages",children:"Sample log messages"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-json",children:'{\n\xa0\xa0\xa0"type":"server",\n\xa0\xa0\xa0"timestamp":"2021-07-12T11:42:25,862+07:00",\n\xa0\xa0\xa0"level":"INFO",\n\xa0\xa0\xa0"component":"o.e.x.s.a.s.FileRolesStore",\n\xa0\xa0\xa0"cluster.name":"elasticsearch",\n\xa0\xa0\xa0"node.name":"v103-157-218-134.3stech.vn",\n\xa0\xa0\xa0"message":"parsed [0] roles from file [/etc/elasticsearch/roles.yml]"\n}\n'})}),"\n",(0,l.jsx)(t.h2,{id:"sample-metrics",children:"Sample metrics"}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-json",children:'{\n "queryId":"A",\n "_source":"sumo_hosted_collector_otel_elasticsearch",\n "state":"completed",\n "thread_pool_name":"analyze",\n "elasticsearch.node.name":"ip-172-31-86-95",\n "elasticsearch.cluster.name":"elasticsearch",\n "metric":"elasticsearch.node.thread_pool.tasks.finished",\n "db.cluster.name":"elastic_otel_cluster",\n "_collectorId":"000000000C5B7100",\n "deployment.environment":"otel_elastic_dev",\n "_sourceId":"0000000000000000",\n "unit":"{tasks}",\n "db.system":"elasticsearch",\n "_sourceHost":"sumoOtelelasticsearch",\n "_collector":"sumo_hosted_collector_otel_elasticsearch",\n "max":0,\n "min":0,\n "avg":0,\n "sum":0,\n "latest":0,\n "count":2\n}\n'})}),"\n",(0,l.jsx)(t.h2,{id:"sample-queries",children:"Sample queries"}),"\n",(0,l.jsx)(t.h3,{id:"sample-logs-query",children:"Sample logs query"}),"\n",(0,l.jsxs)(t.p,{children:["This is a sample log query from\xa0the ",(0,l.jsx)(t.strong,{children:"Errors"})," panel."]}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-sumo",children:'db.system=elasticsearch %"deployment.environment"={{deployment.environment}} db.cluster.name={{db.cluster.name}} ERROR | json "log" as _rawlog nodrop\xa0\n| if (isEmpty(_rawlog), _raw, _rawlog) as _raw\n| json field=_raw "timestamp" as timestamp\n| json field=_raw "level" as level\n| json field=_raw "component" as es_component\n| json field=_raw "message" as message\n| where level = "ERROR"\n| count\n'})}),"\n",(0,l.jsx)(t.h3,{id:"sample-metrics-query",children:"Sample metrics query"}),"\n",(0,l.jsxs)(t.p,{children:["This is a sample metrics query from the ",(0,l.jsx)(t.strong,{children:"JVM Memory Used (MB)"})," panel."]}),"\n",(0,l.jsx)(t.pre,{children:(0,l.jsx)(t.code,{className:"language-sql",children:"deployment.environment=* metric=jvm.memory.heap.used\xa0db.cluster.name=* db.node.name=* | sum by db.cluster.name, db.node.name\n"})}),"\n",(0,l.jsx)(t.h2,{id:"viewing-elasticsearch-dashboards",children:"Viewing Elasticsearch dashboards"}),"\n",(0,l.jsx)(t.p,{children:"All dashboards have a set of filters that you can apply to the entire dashboard. Use these filters to drill down and examine the data to a granular level."}),"\n",(0,l.jsxs)(t.ul,{children:["\n",(0,l.jsxs)(t.li,{children:["You can change the time range for a dashboard or panel by selecting a predefined interval from a drop-down list, choosing a recently used time range, or specifying custom dates and times. ",(0,l.jsx)(t.a,{href:"/docs/dashboards/set-custom-time-ranges/",children:"Learn more"}),"."]}),"\n",(0,l.jsxs)(t.li,{children:["You can use template variables to drill down and examine the data on a granular level. For more information, see ",(0,l.jsx)(t.a,{href:"/docs/dashboards/filter-template-variables/",children:"Filtering Dashboards with Template Variables"}),"."]}),"\n"]}),"\n",(0,l.jsx)(t.h3,{id:"overview",children:"Overview"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Overview"})," dashboard provides the health of Elasticsearch clusters, shards analysis, resource utilization of Elasticsearch host and clusters, search and indexing performance."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Overview.png",alt:"Overview"}),"\n",(0,l.jsx)(t.h3,{id:"total-operations-stats",children:"Total Operations Stats"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Total Operations stats"})," dashboard provides information on the operations of the Elasticsearch system."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Total-Operations-Stats.png",alt:"Total Operations Stats"}),"\n",(0,l.jsx)(t.h3,{id:"thread-pool",children:"Thread Pool"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Thread Pool"})," dashboard analyzes thread pools operations to manage memory consumption of nodes in the cluster."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Thread-Pool.png",alt:"Thread Pool"}),"\n",(0,l.jsx)(t.h3,{id:"resource",children:"Resource"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Resource"})," dashboard monitors JVM Memory, Network, Disk, Network and CPU of Elasticsearch node."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Resource.png",alt:"Resource"}),"\n",(0,l.jsx)(t.h3,{id:"performance-stats",children:"Performance Stats"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Performance Stats"})," dashboard performance statistics such as latency and Translog operations and size."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Performance-Stats.png",alt:"Performance Stats"}),"\n",(0,l.jsx)(t.h3,{id:"indices",children:"Indices"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Indices"})," dashboard monitors Index operations, size and latency. It also provides anal
1ytics on doc values, fields, fixed bitsets, and terms memory."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Indices.png",alt:"Indices"}),"\n",(0,l.jsx)(t.h3,{id:"documents",children:"Documents"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Documents"})," dashboard provides analytics and monitoring on Elasticsearch documents."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Documents.png",alt:"Documents"}),"\n",(0,l.jsx)(t.h3,{id:"caches",children:"Caches"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Caches"})," dashboard allows you to monitor query cache size, evictions and field data memory size."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Caches.png",alt:"Caches"}),"\n",(0,l.jsx)(t.h3,{id:"errors-and-warnings",children:"Errors And Warnings"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Errors And Warnings"})," dashboard shows errors and warnings by Elasticsearch components."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Errors-And-Warnings.png",alt:"Errors And Warnings"}),"\n",(0,l.jsx)(t.h3,{id:"garbage-collection",children:"Garbage Collection"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Garbage Collector"})," dashboard provides information on the garbage collection of the Java Virtual Machine."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Garbage-Collection.png",alt:"Garbage Collection"}),"\n",(0,l.jsx)(t.h3,{id:"login-and-connections",children:"Login And Connections"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Login And Connections"})," dashboard shows geo location of client connection requests, failed connection logins and count of failed login attempts."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Login-And-Connections.png",alt:"Login And Connections"}),"\n",(0,l.jsx)(t.h3,{id:"operations",children:"Operations"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Operations"})," dashboard allows you to monitor server stats and events such as node up/down, index creation/deletion. It also provides disk usage and cluster health status."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Operations.png",alt:"Operations"}),"\n",(0,l.jsx)(t.h3,{id:"queries",children:"Queries"}),"\n",(0,l.jsxs)(t.p,{children:["The ",(0,l.jsx)(t.strong,{children:"Elasticsearch - Queries"})," dashboard shows Elasticsearch provides analytics on slow queries, and query shards."]}),"\n",(0,l.jsx)("img",{src:"https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/Elasticsearch-Queries.png",alt:"Resource Usage"}),"\n",(0,l.jsx)(t.h2,{id:"create-monitors-for-elasticsearch-app",children:"Create monitors for Elasticsearch app"}),"\n","\n",(0,l.jsx)(m.Ay,{}),"\n",(0,l.jsx)(t.h3,{id:"elasticsearch-alerts",children:"Elasticsearch alerts"}),"\n",(0,l.jsxs)(t.table,{children:[(0,l.jsx)(t.thead,{children:(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Alert Name"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Alert Description and conditions"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Alert Condition"}),(0,l.jsx)(t.th,{style:{textAlign:"left"},children:"Recover Condition"})]})}),(0,l.jsxs)(t.tbody,{children:[(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Cluster Red Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Elasticsearch Cluster red health status."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count > = 1"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < 1"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Cluster Yellow Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Elasticsearch Cluster yellow health status."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count > 1"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < = 1"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Disk Out of Space Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"This alerts gets triggered when disk usage is over 90%."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count > 90"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < = 90"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Error Log Too Many Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"This alert gets triggered when error logs exceeds threshold."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count > = 1000"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < 1000"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Healthy Data Nodes Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"This alert gets triggered when missing data node in Elasticsearch cluster."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < = 1"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count > 1"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Heap Usage Too High Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"This alert gets triggered when heap usage is over 90%."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count > 90"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < = 90"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Initializing Shards Too Long Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"This alerts gets triggered when shard initialization takes more than 5 min."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count > = 5"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < 5"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Pending Tasks Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"This alert gets triggered when Elasticsearch has pending tasks."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count > = 5"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < 5"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Query Time Slow Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"This alert gets triggered when slow query time greater than 5 ms."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count >= 1"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < 1"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Query Time Too Slow Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"This alert gets triggered when Slow Query Too High (10 ms)."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count > = 1"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < 1"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Relocating Shards Too Long Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"This alert gets triggered when shards relocation take more than 5 min."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count > = 5"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < 5"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Too Many Slow Query Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"This alert gets triggered when too many slow queries are found in 5 minutes window."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count > = 10"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < 10"})]}),(0,l.jsxs)(t.tr,{children:[(0,l.jsx)(t.td,{style:{textAlign:"left"},children:(0,l.jsx)(t.code,{children:"Elasticsearch - Unassigned Shards Alert"})}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"This alert gets triggered when Elasticsearch has unassigned shards."}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count > 5"}),(0,l.jsx)(t.td,{style:{textAlign:"left"},children:"Count < = 5"})]})]})]})]})}function y(e={}){let{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,l.jsx)(t,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}},863(e,t,s){s.d(t,{Ay:()=>o,RM:()=>r});var n=s(74848),l=s(28453);let r=[];function a(e){let t={admonition:"admonition",li:"li",ol:"ol",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"From your App Catalog:"}),"\n",(0,n.jsxs)(t.ol,{children:["\n",(0,n.jsxs)(t.li,{children:["From the Sumo Logic navigation, select ",(0,n.jsx)(t.strong,{children:"App Catalog"}),"."]}),"\n",(0,n.jsxs)(t.li,{children:["In the ",(0,n.jsx)(t.strong,{children:"Search Apps"})," field, search for and then select your app."]}),"\n",(0,n.jsx)(t.li,{children:"Make sure the app is installed."}),"\n",(0,n.jsxs)(t.li,{children:["Navigate to ",(0,n.jsx)(t.strong,{children:"What's Included"})," tab and scroll down to the ",(0,n.jsx)(t.strong,{children:"Monitors"})," section."]}),"\n",(0,n.jsxs)(t.li,{children:["Click ",(0,n.jsx)(t.strong,{children:"Create"})," next to the pre-configured monitors. In the create monitors window, adjust the trigger conditions and notifications settings based on your requirements."]}),"\n",(0,n.jsxs)(t.li,{children:["Scroll down to ",(0,n.jsx)(t.strong,{children:"Monitor Details"}),"."]}),"\n",(0,n.jsxs)(t.li,{children:["Under ",(0,n.jsx)(t.strong,{children:"Location"})," click on ",(0,n.jsx)(t.strong,{children:"New Folder"}),".","\n",(0,n.jsx)(t.admonition,{type:"note",children:(0,n.jsx)(t.p,{children:"By default, monitor will be saved in the root folder. So to make the maintenance easier, create a new folder in the location of your choice."})}),"\n"]}),"\n",(0,n.jsxs)(t.li,{children:["Enter ",(0,n.jsx)(t.strong,{children:"Folder Name"}),". Folder Description is optional.","\n",(0,n.jsx)(t.admonition,{type:"tip",children:(0,n.jsx)(t.p,{children:"Using app version in the folder name will be helpful to determine the versioning for future updates."})}),"\n"]}),"\n",(0,n.jsxs)(t.li,{children:["Click ",(0,n.jsx)(t.strong,{children:"Create"}),". Once the folder is created, click on ",(0,n.jsx)(t.strong,{children:"Save"}),"."]}),"\n"]})]})}function o(e={}){let{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},23572(e,t,s){s.d(t,{Ay:()=>o,RM:()=>r});var n=s(74848),l=s(28453);let r=[];function a(e){let t={code:"code",p:"p",pre:"pre",strong:"strong",...(0,l.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(t.p,{children:["For Linux systems with ",(0,n.jsx)(t.strong,{children:"ACL Support"}),", the otelcol install process should have created the ACL grants necessary for the otelcol system user to access default log locations. You can verify the active ACL grants using the ",(0,n.jsx)(t.code,{children:"getfacl"})," command. Install the ACL in your Linux environment, if not installed."]}),"\n",(0,n.jsx)(t.p,{children:"The required ACL may not be supported for some rare cases, for example, Linux OS Distro, which is officially not supported by Sumo Logic. In this case, you can run the following command to explicitly grant the permissions."}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{children:"sudo setfacl -R -m d:u:otelcol-sumo:r-x,d:g:otelcol-sumo:r-x,u:otelcol-sumo:r-x,g:otelcol-sumo:r-x <PATH_TO_LOG_FILE>\n"})}),"\n",(0,n.jsx)(t.p,{children:"Run the above command for all the log files in the directory that need to be ingested, which are not residing in the default location."}),"\n",(0,n.jsxs)(t.p,{children:["If Linux ",(0,n.jsx)(t.strong,{children:"ACL Support"})," is not available, traditional Unix-styled user and group permission must be modified. It should be sufficient to add the otelcol system user to the specific group that has access to the log files."]})]})}function o(e={}){let{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},38676(e,t,s){s.d(t,{Ay:()=>i,RM:()=>a});var n=s(74848),l=s(28453),r=s(66497);let a=[];function o(e){let t={admonition:"admonition",code:"code",li:"li",ol:"ol",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.admonition,{type:"info",children:(0,n.jsx)(t.p,{children:"A new source template will always be created with the latest version of the source template."})}),"\n",(0,n.jsx)(t.p,{children:"Follow the below steps to create a data collection configuration to gather the required logs and link them to all the collectors with the help of collector tags."}),"\n",(0,n.jsxs)(t.ol,{children:["\n",(0,n.jsxs)(t.li,{children:["Complete the source template form with the name and file path for your logs (for example, error logs or access logs), then click ",(0,n.jsx)(t.strong,{children:"Next"}),"."]}),"\n",(0,n.jsxs)(t.li,{children:["Under ",(0,n.jsx)(t.strong,{children:"Link Collectors"}),", you will have the option to link the collectors using the collector name or by adding tags to find the group of collectors (for example, ",(0,n.jsx)(t.code,{children:"application = Apache"}),").",(0,n.jsx)("br",{}),(0,n.jsx)("img",{src:(0,r.Ay)("img/send-data/local-file-apache.png"),alt:"Screenshot of the file path configuration for Apache logs",style:{border:"1px solid gray"},width:"80%"})]}),"\n",(0,n.jsxs)(t.li,{children:["Preview and confirm the collectors that will be linked (fetched automatically) to the newly created source template.",(0,n.jsx)("br",{}),(0,n.jsx)("img",{src:(0,r.Ay)("img/send-data/preview-collectors1.png"),alt:"Screenshot showing the linked collectors preview",style:{border:"1px solid gray"},width:"90%"}),(0,n.jsx)("br",{}),(0,n.jsx)("img",{src:(0,r.Ay)("img/send-data/preview-collectors2.png"),alt:"Screenshot showing the linked collectors preview",style:{border:"1px solid gray"},width:"90%"})]}),"\n",(0,n.jsxs)(t.li,{children:["Click ",(0,n.jsx)(t.strong,{children:"Next"})," to complete the source template creation. In the background, the system will apply the configuration to all the linked collectors and will start collecting the respective telemetry data from the remote host (in the example, it would start collecting Apache error logs)."]}),"\n",(0,n.jsxs)(t.li,{children:["Click the ",(0,n.jsx)(t.strong,{children:"Log Search"})," or ",(0,n.jsx)(t.strong,{children:"Metrics Search"})," icons to search for and analyze your data collected for this source template."]}),"\n"]})]})}function i(e={}){let{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},6232(e,t,s){s.d(t,{Ay:()=>i,RM:()=>a});var n=s(74848),l=s(28453),r=s(66497);let a=[];function o(e){let t={a:"a",admonition:"admonition",code:"code",li:"li",ol:"ol",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"In this step, we'll install remotely managed OpenTelemetry collector and add a uniquely identifiable tag to these collectors."}),"\n",(0,n.jsxs)(t.ol,{children:["\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.a,{href:"/docs/get-started/sumo-logic-ui-classic",children:(0,n.jsx)(t.strong,{children:"Classic UI"})}),". In the main Sumo Logic menu, Select ",(0,n.jsx)(t.strong,{children:"App Catalog"}),".",(0,n.jsx)
1("br",{}),(0,n.jsx)(t.a,{href:"/docs/get-started/sumo-logic-ui",children:(0,n.jsx)(t.strong,{children:"New UI"})}),". In the Sumo Logic main menu select ",(0,n.jsx)(t.strong,{children:"App Catalog"}),"."]}),"\n",(0,n.jsx)(t.li,{children:"In the \u{1F50E} Search Apps field, run a search for your desired OpenTelemetry app, then select it. For example, Apache - OpenTelemetry."}),"\n",(0,n.jsxs)(t.li,{children:["Click the ",(0,n.jsx)(t.strong,{children:"Manage"})," dropdown and then select ",(0,n.jsx)(t.strong,{children:"Add Collection"}),"."]}),"\n",(0,n.jsxs)(t.li,{children:["On the ",(0,n.jsx)(t.strong,{children:"Set Up Collector"})," page, select ",(0,n.jsx)(t.strong,{children:"Add a New Collector"})," and then click ",(0,n.jsx)(t.strong,{children:"Next"}),"."]}),"\n"]}),"\n",(0,n.jsx)(t.admonition,{type:"note",children:(0,n.jsxs)(t.p,{children:["If you want to use an existing OpenTelemetry Collector, you can skip this step by selecting the ",(0,n.jsx)(t.strong,{children:"Use an existing Collector"})," option."]})}),"\n",(0,n.jsxs)(t.ol,{start:"5",children:["\n",(0,n.jsxs)(t.li,{children:["Select the platform where you want to install the Sumo Logic OpenTelemetry Collector. For example, Linux.",(0,n.jsx)("br",{}),"\nThis will generate a command that you can execute in the machine environment you need to monitor. Once executed, it will install the Sumo Logic OpenTelemetry Collector.",(0,n.jsx)("br",{}),(0,n.jsx)("img",{src:(0,r.Ay)("img/send-data/opentelemetry-collector/remotely-managed.png"),alt:"Remotely Managed icon"}),"\nThe installation commands now include a ",(0,n.jsx)(t.code,{children:"--remotely-managed"})," flag. When this flag is used, a remotely managed collector is installed automatically instead of a locally managed one. If you prefer to use a locally managed collector, simply remove the flag from the installation command."]}),"\n"]})]})}function i(e={}){let{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},86206(e,t,s){s.d(t,{Ay:()=>o,RM:()=>r});var n=s(74848),l=s(28453);let r=[];function a(e){let t={a:"a",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Timestamp Parsing"}),". You can configure timestamp parsing for logs ingested using this source template. For more information, see ",(0,n.jsx)(t.a,{href:"/docs/send-data/opentelemetry-collector/remote-management/source-templates/otrm-time-reference",children:"Timestamps, Time Zones, Time Ranges, and Date Formats for the OpenTelemetry Collector"}),"."]})}function o(e={}){let{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},11429(e,t,s){s.d(t,{Ay:()=>o,RM:()=>r});var n=s(74848),l=s(28453);let r=[];function a(e){let t={a:"a",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.strong,{children:"Processing Rules"}),". You can add ",(0,n.jsx)(t.strong,{children:"processing rules"})," for logs/metrics collected. To learn more, refer to ",(0,n.jsx)(t.a,{href:"/docs/send-data/opentelemetry-collector/remote-management/processing-rules",children:"Processing Rules"}),"."]})}function o(e={}){let{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},44077(e,t,s){s.d(t,{Ay:()=>o,RM:()=>r});var n=s(74848),l=s(28453);let r=[];function a(e){let t={code:"code",li:"li",p:"p",strong:"strong",ul:"ul",...(0,l.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"In this step, you will configure the YAML required for Elasticsearch collection. Below are the inputs required for configuration:"}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Name"}),". Name of the source template."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Description"}),". Description for the source template."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Log Filepath"}),". Location where the Elasticsearch logs are logged. Please refer to your elasticsearch.conf file."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Endpoint"}),". Enter the url of the server you need to monitor. (default: ",(0,n.jsx)(t.code,{children:"localhost:9200"}),")."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Username"}),". Enter the Elasticsearch username."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Password Environment Variable Name"}),". Enter the Elasticsearch password environment variable name."]}),"\n",(0,n.jsxs)(t.li,{children:[(0,n.jsx)(t.strong,{children:"Fields/Metadata"}),". You can provide any customer fields to be tagged with the data collected. By default, Sumo Logic tags ",(0,n.jsx)(t.code,{children:"_sourceCategory"})," with the value otel/elasticsearch user needs to provide the value for ",(0,n.jsx)(t.code,{children:"db.cluster.name"}),"."]}),"\n"]})]})}function o(e={}){let{wrapper:t}={...(0,l.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},57250(e,t,s){s.d(t,{A:()=>
1o});var n=s(74848);s(96540);var l=s(18215),r=s(57663);function a({children:e,className:t,hidden:s}){return(0,n.jsx)("div",{role:"tabpanel",className:(0,l.A)("tabItem_Ymn6",t),hidden:s,children:e})}function o({children:e,className:t,value:s}){let{selectedValue:l,lazy:i}=(0,r.uc)(),c=s===l;return!c&&i?null:(0,n.jsx)(a,{className:t,hidden:!c,children:e})}},50773(e,t,s){s.d(t,{A:()=>u});var n=s(74848);s(96540);var l=s(18215),r=s(88287),a=s(57663),o=s(28584),i=s(19863);function c({className:e}){let{selectedValue:t,selectValue:s,tabValues:r,block:i}=(0,a.uc)(),d=[],{blockElementScrollPositionUntilNextRender:h}=(0,o.a_)(),u=e=>{let n=e.currentTarget,l=r[d.indexOf(n)].value;l!==t&&(h(n),s(l))},m=e=>{let t=null;switch(e.key){case"Enter":u(e);break;case"ArrowRight":{let s=d.indexOf(e.currentTarget)+1;t=d[s]??d[0];break}case"ArrowLeft":{let s=d.indexOf(e.currentTarget)-1;t=d[s]??d[d.length-1]}}t?.focus()};return(0,n.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,l.A)("tabs",{"tabs--block":i},e),children:r.map(({value:e,label:s,attributes:r})=>(0,n.jsx)("li",{role:"tab",tabIndex:t===e?0:-1,"aria-selected":t===e,ref:e=>{d.push(e)},onKeyDown:m,onClick:u,...r,className:(0,l.A)("tabs__item","tabItem_LNqP",r?.className,{"tabs__item--active":t===e}),children:s??e},e))})}function d({children:e}){return(0,n.jsx)("div",{className:"margin-top--md",children:e})}function h({className:e,children:t}){return(0,n.jsxs)("div",{className:(0,l.A)(r.G.tabs.container,"tabs-container","tabList__CuJ"),children:[(0,n.jsx)(c,{className:e}),(0,n.jsx)(d,{children:t})]})}function u(e){let t=(0,i.A)(),s=(0,a.OC)(e);return(0,n.jsx)(a.O_,{value:s,children:(0,n.jsx)(h,{className:e.className,children:(0,a.vT)(e.children)})},String(t))}},57663(e,t,s){s.d(t,{OC:()=>u,O_:()=>g,uc:()=>p,vT:()=>d});var n=s(74848),l=s(96540),r=s(56347),a=s(99989),o=s(96629),i=s(80618),c=s(41367);function d(e){return l.Children.toArray(e).filter(e=>"\n"!==e)}function h({value:e,tabValues:t}){return t.some(t=>t.value===e)}function u(e){let t,{defaultValue:s,queryString:n=!1,groupId:d}=e,u=function(e){let{values:t,children:s}=e;return(0,l.useMemo)(()=>{let e=t??l.Children.toArray(s).flatMap(e=>{if(!e)return[];if((0,l.isValidElement)(e)&&function(e){let{props:t}=e;return!!t&&"object"==typeof t&&"value"in t}(e))return[e];let t="string"==typeof e.type?e.type:e.type.name;throw Error(`Docusaurus error: Bad <Tabs> child <${t}>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop. 2If you do not want to pass on a "value" prop to the direct children of <Tabs>, you can also pass an explicit <Tabs values={...}> prop.`)}).map(({props:{value:e,label:t,attributes:s,default:n}})=>({value:e,label:t,attributes:s,default:n})),n=(0,i.XI)(e,(e,t)=>e.value===t.value);if(n.length>0)throw Error(`Docusaurus error: Duplicate values "${n.map(e=>`'${e.value}'`).join(", ")}" found in <Tabs>. Every value needs to be unique.`);return e},[t,s])}(e),[m,p]=(0,l.useState)(()=>(function({defaultValue:e,tabValues:t}){if(0===t.length)throw Error("Docusaurus error: the <Tabs> component requires at least one <TabItem> children component");if(e){if(!h({value:e,tabValues:t}))throw Error(`Docusaurus error: The <Tabs> has a defaultValue "${e}" but none of its children has the corresponding value. Available values are: ${t.map(e=>e.value).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return e}let s=t.find(e=>e.default)??t[0];if(!s)throw Error("Unexpected error: 0 tabValues");return s.value})({defaultValue:s,tabValues:u})),[g,x]=function({queryString:e=!1,groupId:t}){let s=(0,r.W6)(),n=function({queryString:e=!1,groupId:t}){if("string"==typeof e)return e;if(!1===e)return null;if(!0===e&&!t)throw Error('Docusaurus error: The <Tabs> component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return t??null}({queryString:e,groupId:t});return[(0,o.aZ)(n),(0,l.useCallback)(e=>{if(!n)return;let t=new URLSearchParams(s.location.search);t.set(n,e),s.replace({...s.location,search:t.toString()})},[n,s])]}({queryString:n,groupId:d}),[j,f]=function({groupId:e}){let t=e?`docusaurus.tab.${e}`:null,[s,n]=(0,c.Dv)(t);return[s,(0,l.useCallback)(e=>{t&&n.set(e)},[t,n])]}({groupId:d}),y=h({value:t=g??j,tabValues:u})?t:null;return(0,a.A)(()=>{y&&p(y)},[y]),{selectedValue:m,selectValue:(0,l.useCallback)(e=>{if(!h({value:e,tabValues:u}))throw Error(`Can't select invalid tab value=${e}`);p(e),x(e),f(e)},[x,f,u]),tabValues:u,lazy:e.lazy??!1,block:e.block??!1}}let m=(0,l.createContext)(null);function p(){let e=l.useContext(m);if(!e)throw Error("useTabsContext() must be used within a Tabs component");return e}function g(e){return(0,n.jsx)(m.Provider,{value:e.value,children:e.children})}},28453(e,t,s){s.d(t,{R:()=>a,x:()=>o});var n=s(96540);let l={},r=n.createContext(l);function a(e){let t=n.useContext(r);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.