cwielenb/CNCF-Dataset huggingface dataset:
Project: Checkmk (Observability and Analysis / Observability)
File: 16371.md

key | value | date | 2024-02-23T08:00:57+00:00 version | 2.4.0b1 class | fix edition | cee component | rest-api level | 1 compatible | yes Before this werk, when the sla was computed for a predefined time range without specifying the range field, an error status 500 Internal Server Error was returned. This werk solves the problem by checking for the existence of the range field, and if it does not exist, the endpoint returns an error status 400 - Bad Request.
Project: HertzBeat (Observability and Analysis / Observability)
File: upgrade.md

id: upgrade title: HertzBeat New Version Upgrade sidebar_label: Version Upgrade Guide HertzBeat Release Version List HertzBeat's metadata information is stored in H2 or Mysql, PostgreSQL relational databases, and the collected metric data is stored in time series databases such as TDengine and IotDB. You need to save and back up the data files of the database and monitoring templates yml files before upgrading If using custom monitoring templates Need to back up docker templates directory `docker cp hertzbeat:/opt/hertzbeat/define ./define` in the container `/opt/hertzbeat/define` `docker cp hertzbeat:/opt/hertzbeat/define ./define` And mount the template define directory when docker start `-v $(pwd)/define:/opt/hertzbeat/define` `-v $(pwd)/define:/opt/hertzbeat/define` If using the built-in default H2 database Need to mount or back up `-v $(pwd)/data:/opt/hertzbeat/data` database file directory in the container `/opt/hertzbeat/data` Stop and delete the container, delete the local HertzBeat docker image, and pull the new version image Refer to [Docker installation of HertzBeat] (docker-deploy) to create a new container using a new image. Note that the database file directory needs to be mounted `-v $(pwd)/data:/opt/hertzbeat/data` If using external relational database Mysql, PostgreSQL No need to mount the database file directory in the backup container Stop and delete the container, delete the local HertzBeat docker image, and pull the new version image Refer to [Docker installation HertzBeat] (docker-deploy) to create a new container using the new image, and configure the database connection in `application.yml` If using the built-in default H2 database Back up the database file directory under the installation package `/opt/hertzbeat/data` If there is a custom monitoring template, you need to back up the template YML under `/opt/hertzbeat/define` `bin/shutdown.sh` stops the HertzBeat process and downloads the new installation package Refer to to start using the new installation package If using external relational database Mysql, PostgreSQL No need to back up the database file directory under the installation package If there is a custom monitoring template, you need to back up the template YML under `/opt/hertzbeat/define` `bin/shutdown.sh` stops the HertzBeat process and downloads the new installation package Refer to to start with the new installation package and configure the database connection in `application.yml` HAVE FUN
Project: HertzBeat (Observability and Analysis / Observability)
File: postgresql-change.md

id: postgresql-change title: Use PostgreSQL Replace H2 Database to Store Metadata(Optional) sidebar_label: Use PostgreSQL Instead of H2 PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, HertzBeat allow you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information. If you have the PostgreSQL environment, can be directly to database creation step. Download and install the Docker environment Docker tools download refer to After the installation you can check if the Docker version normally output at the terminal. ``` $ docker -v Docker version 20.10.12, build e91ed57 ``` Install PostgreSQL with Docker ``` $ docker run -d --name postgresql -p 5432:5432 -e POSTGRESUSER=root -e POSTGRESPASSWORD=123456 -e TZ=Asia/Shanghai postgresql:15 ``` use```$ docker ps```to check if the database started successfully Create database in container manually or with . Enter postgreSQL or use the client to connect postgreSQL service ``` su - postgres psql ``` Create database named hertzbeat `CREATE DATABASE hertzbeat;` Check if hertzbeat database has been successfully created `\l` Configure HertzBeat's configuration file Modify `hertzbeat/config/application.yml` configuration file NoteThe docker container way need to mount application.yml file locally, while you can use installation package way to unzip and modify `hertzbeat/config/application.yml` Replace `spring.database` data source parameters, URL account and password. ```yaml spring: datasource: driver-class-name: org.h2.Driver username: sa password: 123456 url: jdbc:h2:./data/hertzbeat;MODE=MYSQL ``` Specific replacement parameters are as follows and you need to configure account, ip, port according to the postgresql environment: ```yaml spring: config: activate: on-profile: prod datasource: driver-class-name: org.postgresql.Driver username: root password: 123456 url: jdbc:postgresql://127.0.0.1:5432/hertzbeat hikari: max-lifetime: 120000 jpa: database: postgresql hibernate: ddl-auto: update properties: hibernate: dialect: org.hibernate.dialect.PostgreSQLDialect ``` Start HertzBeat visit http://ip:1157/ on the browser You can use HertzBeat monitoring alarm, default account and password are admin/hertzbeat
Project: Graylog (Observability and Analysis / Observability)
File: PageHeader.md

Simple page header with only a title and description: ```js <PageHeader title="This is a simple page"> <span>Here goes the page description</span> </PageHeader> ``` Page header with description, documentation link, and action. Notice that there is no border around the header, as the `subpage` prop is set: ```js import { Button } from 'components/bootstrap'; import DocsHelper from 'util/DocsHelper'; <PageHeader title="Here goes the page title" lifecycle="experimental" subpage actions={<Button bsStyle="success">Action</Button>} documentationLink={{ title: 'Alerts documentation', path: DocsHelper.PAGES.WELCOME, }}> <span>This is a page description</span> <span>This is a support message</span> </PageHeader> ```
Project: Tracetest (Observability and Analysis / Observability)
File: tracetest_dashboard.md

Opens the Tracetest Dashboard URL Opens the Tracetest Dashboard URL ``` tracetest dashboard [flags] ``` ``` -h, --help help for dashboard ``` ``` -c, --config string config file will be used by the CLI (default "config.yml") -o, --output string output format [pretty|json|yaml] -s, --server-url string server url -v, --verbose display debug information ``` - CLI to configure, install and execute tests on a Tracetest server
Project: Grafana (Observability and Analysis / Observability)
File: release-notes-8-1-4.md

_build: list: false labels: products: cloud enterprise oss title: Release notes for Grafana 8.1.4 <!-- Auto generated by update changelog github action --> Explore: Ensure logs volume bar colors match legend colors. , LDAP: Search all DNs for users. , Alerting: Fix notification channel migration. , Annotations: Fix blank panels for queries with unknown data sources. , BarChart: Fix stale values and x axis labels. , Graph: Make old graph panel thresholds work even if ngalert is enabled. , InfluxDB: Fix regex to identify `/` as separator. , LibraryPanels: Fix update issues related to library panels in rows. , Variables: Fix variables not updating inside a Panel when the preceding Row uses "Repeat For". ,
Project: Checkmk (Observability and Analysis / Observability)
File: 16320.md

key | value | compatible | no version | 2.4.0b1 date | 2024-03-05T12:32:34+00:00 level | 1 class | fix component | multisite edition | cre Werk 13498 introduced the possibility to set publish permissions independently of each other. Still, the permission "Publish views" (e.g. for publishing views) was needed to see the published views. This has been fixed. Note: Please check your publish configuration in views, dashboards, etc.
Project: Logging Operator (Kube Logging) (Observability and Analysis / Observability)
File: common_types.md

title: Common weight: 200 generated_file: true ImageSpec struct hold information about image specification Metrics defines the service monitor endpoints BufferMetrics defines the service monitor endpoints ServiceMonitorConfig defines the ServiceMonitor properties Security defines Fluentd, FluentbitAgent deployment security properties Warning: this is not supported anymore and does nothing ReadinessDefaultCheck Enable default readiness checks Enable default Readiness check it'll fail if the buffer volume free space exceeds the `readinessDefaultThreshold` percentage (90%).
Project: Grafana Tempo (Observability and Analysis / Observability)
File: s3.md

title: Amazon S3 permissions menuTitle: Amazon S3 description: Set Amazon S3 permissions for Tempo. aliases: ../../configuration/s3/ # /docs/tempo/<TEMPO_VERSION>/configuration/s3/ For configuration options, refer to the storage section on the page. The following authentication methods are supported: AWS environment variables `AWSACCESSKEYID` and `AWSSECRETACCESSKEY` Static access key and secret credentials specified in `accesskey` and `secretkey` MinIO environment variables `MINIOACCESSKEY` and `MINIOSECRETKEY` AWS shared credentials MinIO client credentials AWS IAM (, AWS ) The following IAM policy shows minimal permissions required by Tempo, where the bucket has already been created. ```json { "Version": "2012-10-17", "Statement": [ { "Sid": "TempoPermissions", "Effect": "Allow", "Action": [ "s3:PutObject", "s3:GetObject", "s3:ListBucket", "s3:DeleteObject", "s3:GetObjectTagging", "s3:PutObjectTagging" ], "Resource": [ "arn:aws:s3:::<bucketname>/*", "arn:aws:s3:::<bucketname>" ] } ] } ``` A lifecycle policy is recommended that deletes incomplete multipart uploads after one day.
Project: OpenSearch (Observability and Analysis / Observability)
File: opensearch.release-notes-2.5.0.md

Prevent deletion of snapshots that are backing searchable snapshot indexes () Reject bulk requests with invalid actions () Add maxshardsize parameter for shrink API () Add experimental support for extensions (), (), (), ()) Add support to register settings dynamically () Add auto release workflow () Add CI bundle pattern to distribution download () Experimental support for extended backward compatiblity in searchable snapshots () Add support of default replica count cluster setting () Add support for refresh level durability () Add Request level Durability using Remote Translog functionality () Support to fail open requests on search shard failures with weighted traffic routing () Support versioning for Weighted routing apis() Add support for discovered cluster manager and remove local weights () Add new level to get health per awareness attribute in _cluster/health () Change http code for DecommissioningFailedException from 500 to 400 () Pre conditions check before updating weighted routing metadata () Support remote translog transfer for request level durability () Gracefully handle concurrent zone decommission action () Refactor fuzziness interface on query builders () Fix case sensitivity for wildcard queries () Apply cluster manager throttling settings during bootstrap () Update thresholds map when cluster manager throttling setting is removed () Fix backward compatibility for static cluster manager throttling threshold setting () Fix index exclusion behavior in snapshot restore and clone APIs () Fix graph filter error in search () Bumps `bcpg-fips` from 1.0.5.1 to 1.0.7.1 () Bumps `commons-compress` from 1.21 to 1.22 () Bumps `geoip2` from 3.0.1 to 3.0.2 in /modules/ingest-geoip () Bumps `gson` from 2.9.0 to 2.10 in /plugins/repository-hdfs () Bumps `protobuf-java` from 3.21.8 to 3.21.9 in /test/fixtures/hdfs-fixture () Bumps `gradle-extra-configurations-plugin` from 7.0.0 to 8.0.0 () Bumps `jcodings` from 1.0.57 to 1.0.58 () Bumps `google-http-client-jackson2` from 1.35.0 to 1.42.3 () Bumps `azure-core` from 1.33.0 to 1.34.0 () Bumps `azure-core-http-netty` from 1.12.4 to 1.12.7 () Bumps `maxmind-db` from 2.0.0 to 2.1.0 () Bumps `json-schema-validator` from 1.0.69 to 1.0.73 () Bumps `proto-google-common-protos` from 2.8.0 to 2.10.0 () Bumps `protobuf-java` from 3.21.7 to 3.21.9 () Bumps `gradle` from 7.5 to 7.6 () Bumps `jackson` from 2.14.0 to 2.14.1 () Bumps `apache-rat` from 0.13 to 0.15 () Bumps `reactor-netty` from 1.0.18 to 1.1.1 () Bumps `gradle-info-plugin` from 7.1.3 to 12.0.0 ()
Project: Pinpoint (Observability and Analysis / Observability)
File: troubleshooting.md

name: Troubleshooting about: For when something doesn't work Please check the , and search existing for similar questions before creating a new issue.YOU MAY DELETE THIS PREREQUISITES SECTION. , and and found no answer. master/v1.7.3/v1.7.2 etc. A clear and concise description of what is not working. Steps you have taken to trigger the problem, for example: Launched '...' with agent Tried tracing '...' (see agent log below) Collector outputs trace log (see collector log below) No trace shows up in the web UI (see web log below) If applicable, add screenshots to help explain your problem. If applicable, please attach agent/collector/web DEBUG log that includes the part where you have encountered the problem. In case of agents, including the start-up log may be of great help. Add any other context about the problem here, such as affected library for agents, how your collector/web/hbase is set up if applicable.
Project: Netdata (Observability and Analysis / Observability)
File: vernemq_queue_message_unhandled.md

This alert is raised when the number of unhandled messages in the last minute, monitored by the Netdata Agent, is too high. It indicates that many messages were not delivered due to connections with `clean_session=true` in a VerneMQ messaging system. In MQTT, `clean_session=true` means that the client doesn't want to store any session state on the broker for the duration of its connection. When the session is terminated, all subscriptions and messages are deleted. The broker won't store any messages or send any missed messages once the client reconnects. Unhandled messages are messages that cannot be delivered to subscribers due to connection issues, protocol limitations, or session configurations. These messages are often related to clients' settings for `clean_session=true`, which means they don't store any session state on the broker. Identify clients causing unhandled messages One way to find the clients causing unhandled messages is by analyzing the VerneMQ log files. Look for warning or error messages related to undelivered messages or clean sessions. The log files are typically located in `/var/log/vernemq/`. Check clients' clean_session settings Review your MQTT clients' configurations to verify if they have `cleansession=true`. Consider changing the setting to `cleansession=false` if you want the broker to store session state and send missed messages upon reconnection. Monitor VerneMQ statistics Use the following command to see an overview of the VerneMQ statistics: ``` vmq-admin metrics show ``` Look for metrics related to dropped or unhandled messages, such as `gauge.queuemessageunhandled`. Examine your system resources High unhandled message rates can also be a result of insufficient system resources. Check your system resources (CPU, memory, disk usage) and consider upgrading if necessary.
Project: Checkmk (Observability and Analysis / Observability)
File: 16382.md

key | value | date | 2024-03-13T06:09:17+00:00 version | 2.4.0b1 class | fix edition | cre component | wato level | 1 compatible | no This werk is incompatible for users using the rule previously named "Disable bulk walks on SNMPv2c/v3" (see below for details). The ruleset for disabling bulkwalks has not been correctly applied to SNMPv3 hosts using the inline backend in the past. In addition it has been interfering with the ruleset to enable SNMP version 2 (over version 1). The following new ruleset names are introduced: "Disable bulkwalks" (formerly known as "Disable bulk walks on SNMPv2c/v3") "Enable SNMPv2c for hosts" (formerly known as "Enable SNMPv2c and bulk walk for hosts") "Enable SNMPv2c for management boards" (formerly known as "Enable SNMPv2c and bulk walk for management boards") With this change the following logic applies: bulkwalk*: The "bulkwalk" query is used if and only if the ruleset "Disable bulkwalks" does not match the host and it is available in the used SNMP version (v1 does not have "bulkwalk"). SNMP version*: Checkmk will use SNMP v3 if and only if the host configuration contains SNMP v3 style credentials. The remaining hosts will use SNMP v2c if and only if the ruleset "Enable SNMPv2c for hosts" matches, otherwise SNMPv1. This applies to both the "inline" and the "classic" backend. Previously, in order to succesfully disable SNMP bulkwalks, users had to make sure the "Disable bulk walks on SNMPv2c/v3" matched the host, and the "Enable SNMPv2c and bulk walk for hosts" did not match the host. This is no longer the case. All hosts that are neither configured for SNMPv3 (see above) nor matched by the "Enable SNMPv2c" ruleset will use SNMPv1.
Project: Checkmk (Observability and Analysis / Observability)
File: 16013.md

key | value | compatible | yes version | 2.3.0b1 date | 2024-01-17T09:18:22+00:00 level | 1 class | fix component | ec edition | cee With werk 16012 the event console rules are filtered ond saved to the location var/mkeventd/active_config during activate changes. This werk fixes the missing procedure while updating to a new Checkmk version.
Project: Grafana (Observability and Analysis / Observability)
File: what-is-grafana.md

labels: products: enterprise oss title: Grafana Open Source Grafana open source is open source visualization and analytics software. It allows you to query, visualize, alert on, and explore your metrics, logs, and traces no matter where they are stored. It provides you with tools to turn your time-series database (TSDB) data into insightful graphs and visualizations. Grafana Loki is an open source, set of components that can be composed into a fully featured logging stack. For more information, refer to . Grafana Tempo is an open source, easy-to-use and high-volume distributed tracing backend. For more information, refer to . Grafana Mimir is an open source software project that provides a scalable long-term storage for Prometheus. For more information about Grafana Mimir, refer to . Grafana OnCall is an open source incident response management tool built to help teams improve their collaboration and resolve incidents faster. For more information about Grafana OnCall, refer to .
Project: Tracetest (Observability and Analysis / Observability)
File: tracetest.md

CLI to configure, install and execute tests on a Tracetest server CLI to configure, install and execute tests on a Tracetest server ``` -c, --config string config file will be used by the CLI (default "config.yml") -h, --help help for tracetest -o, --output string output format [pretty|json|yaml] -s, --server-url string server url -v, --verbose display debug information ``` - Apply resources - Generate the autocompletion script for the specified shell - Configure your tracetest CLI - Opens the Tracetest Dashboard URL - Delete resources - Export resource - Get resource - List resources - Run tests and test suites - Manage your tracetest server - Start Tracetest - Display this CLI tool version - Waits for a run group to be finished
Project: Botkube (Observability and Analysis / Observability)
File: SECURITY.md

Please do not report security vulnerabilities through public GitHub issues. To report security vulnerabilities in Botkube project, please email with a detailed description of the issue. If the issue is confirmed, we will release a patch as soon as possible depending on complexity. Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: Type of issue. For example, buffer overflow, SQL injection, cross-site scripting, etc. The location of the affected source code. Repository name with tag/branch/commit or direct URL. Step-by-step instructions to reproduce the issue. Impact of the issue, including how an attacker might exploit the issue. This information will help us triage your report more quickly.
Project: Vector (Observability and Analysis / Observability)
File: gcp_pubsub.md

title: GCP PubSub description: Fetch observability events from GCP's messaging system component_kind: source layout: component tags: ["gcp", "pubsub", "component", "source"] {{/* This doc is generated using: The template in layouts/docs/component.html The relevant CUE data in cue/reference/components/... */}}
Project: Thanos (Observability and Analysis / Observability)
File: dashboards.md

There exists Grafana dashboards for each component (not all of them complete) targeted for environments running Kubernetes: You can import them via `Import -> Paste JSON` in Grafana. These dashboards require Grafana 5 or above, importing them in older versions are known not to work. All dashboards are generated using and check out for further information.
Project: Netdata (Observability and Analysis / Observability)
File: 10min_netisr_backlog_exceeded.md

The `10minnetisrbacklogexceeded` alert occurs when the `netisrmaxqlen` queue within FreeBSD's network kernel dispatch service reaches its maximum capacity. This queue stores packets received by interfaces and waiting to be processed by the destined subsystems or userland applications. When the queue is full, the system drops new packets. This alert indicates that the average number of dropped packets in the last minute has exceeded the netisr queue length. Increase the netisr_maxqlen value a. Check the current value: ``` root@netdata~ # sysctl net.route.netisr_maxqlen net.route.netisr_maxqlen: 256 ``` b. Increase the value by a factor of 4: ``` root@netdata~ # sysctl -w net.route.netisr_maxqlen=1024 ``` c. Verify the change and test with the same workload that triggered the alarm originally: ``` root@netdata~ # sysctl net.route.netisr_maxqlen net.route.netisr_maxqlen: 1024 ``` d. If the change works for your system, make it permanent by adding this entry, `net.route.netisr_maxqlen=1024`, to `/etc/sysctl.conf`. e. Reload the sysctl settings: ``` root@netdata~ # /etc/rc.d/sysctl reload ``` Monitor the system After increasing the `netisrmaxqlen` value, continue to monitor your system's dropped packet statistics using tools like `netstat` to determine if the queue backlog situation has improved. If you are still experiencing high packet drop rates, you may need to further increase the `netisrmaxqlen` value, or explore other optimizations for your networking stack. Check hardware and system resources In some cases, overloaded or underpowered hardware may cause issues with packet processing. Ensure that your hardware (network cards, switches, routers, etc.) is performing optimally, and that your system has enough CPU and RAM resources to handle the traffic load. Network traffic analysis Analyze your network traffic using tools like `tcpdump`, `iftop`, or `iptraf` to identify specific traffic patterns or types causing the backlog issue. This analysis can help you optimize your network infrastructure or take actions to reduce unnecessary traffic. Update FreeBSD version Ensure that your FreeBSD system is up to date, as newer kernel versions may include performance improvements and optimizations for packet processing. Updating to a newer version might help resolve netisr backlog issues.