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

title: "InfluxDB" weight: 5 This document is a getting started guide to integrating InfluxDB data pipelines with M3. To write metrics to M3 using the InfluxDB line protocol, simply form the request as you typically would line separated and POST the body to `/api/v1/influxdb/write` on the coordinator. Note that timestamp is in nanoseconds from Unix epoch. This example writes two metrics `weathertemperature` and `weatherwind` using the current time in nanoseconds as the timestamp: ```shell curl -i -X POST "{{% apiendpoint %}}influxdb/write" --data-binary "weather,location=us-midwest temperature=82,wind=42 $(expr $(date +%s) \* 1000000000)" ``` After successfully written you can query for these metrics using PromQL. All measurements are translated into metric names by concatenating the name with the measurement name. The previous example forms the two following Prometheus time series: ``` weather_temperature{location="us-midwest"} 82 weather_wind{location="us-midwest"} 42 ``` All metric names and labels are rewritten to contain only alphanumeric characters. Any non-alphanumeric characters are rewritten with an underscore.
Project: SkyWalking (Observability and Analysis / Observability)
File: virtual-mq.md

Virtual MQ represent the MQ nodes detected by . The performance metrics of the MQ are also from the MQ client-side perspective. For example, Kafka plugins in the Java agent could detect the transmission latency of message As a result, SkyWalking would show message count, transmission latency, success rate powered by backend analysis capabilities in this dashboard. The MQ operation span should have It is an Exit(at producer side) or Entry(at consumer side) span Span's layer == MQ Tag key = `mq.queue`, value = MQ queue name Tag key = `mq.topic`, value = MQ queue topic , it's optional as some MQ don't have topic concept. Tag key = `transmission.latency`, value = Transmission latency from consumer to producer Set `peer` at both sides(producer and consumer). And the value of peer should represent the MQ server cluster.
Project: Flagsmith (Observability and Analysis / Feature Flagging)
File: api-usage.md

title: API Usage Flagsmith will track API calls made by the SDKS and store them in its data-store. You can view this data by going to the Organisation settings page and clicking on Usage. You can also drill down into Projects and Environments. Flagsmith tracks the following request types: Get Flags Get Identity Flags Set Identity Traits Get (for local evaluation SDKs) Flagsmith also tracks Flag Evaluations with .
Project: gocrane (Observability and Analysis / Continuous Optimization)
File: quick-start.md

title: "Quick Start" description: "Quick Start guide for Crane" weight: 10 Welcome to Crane! In this document, we will work through how to install Crane and visit Crane Dashboard in your local environments: Create a local running Kubernetes cluster by Install Prometheus and Grafana by Install Crane by Visit Crane Dashboard via kubectl port-forward Please referring to to know more about how to install crane kubectl Kubernetes 1.18+ Helm 3.1.0 Kind 0.16+ {{% alert color="warning" %}} If your Kubernetes version >= 1.26, please referring to {{% /alert %}} Following command will install Crane with dependencies applications(Prometheus/Grafana). ```bash curl -sf https://raw.githubusercontent.com/gocrane/crane/main/hack/local-env-setup.sh | sh - ``` Make sure all pods are running: ```bash $ export KUBECONFIG=${HOME}/.kube/config_crane $ kubectl get deploy -n crane-system NAME READY STATUS RESTARTS AGE crane-agent-5r9l2 1/1 Running 0 4m40s craned-6dcc5c569f-vnfsf 2/2 Running 0 4m41s fadvisor-5b685f4cd6-xpxzq 1/1 Running 0 4m37s grafana-64656f6d54-6l24j 1/1 Running 0 4m46s metric-adapter-967c6d57f-swhfv 1/1 Running 0 4m41s prometheus-kube-state-metrics-7f9d78cffc-p8l7c 1/1 Running 0 4m46s prometheus-node-exporter-4wk8b 1/1 Running 0 4m40s prometheus-server-fb944f4b7-4qqlv 2/2 Running 0 4m46s ``` ```bash kubectl -n crane-system port-forward service/craned 9090:9090 ``` Visit dashboard via
Project: Vector (Observability and Analysis / Observability)
File: dpkg.md

title: Install Vector using dpkg short: dpkg weight: 2 [dpkg] is the software that powers the package management system in the Debian operating system and its derivatives. dpkg is used to install and manage software via `.deb` packages. This page covers installing and managing Vector through the DPKG package repository. ```shell curl \ --proto '=https' \ --tlsv1.2 -O \ https://apt.vector.dev/pool/v/ve/vector{{< version >}}-1{arch}.deb sudo dpkg -i vector{{< version >}}-1{arch}.deb ``` Make sure to replace `{arch}` with one of the following: `amd64` `arm64` `armhf` {{< tabs default="Upgrade Vector" >}} {{< tab title="Upgrade Vector" >}} ```shell dpkg -i vector-{{< version >}}-{arch} ``` {{< /tab >}} {{< tab title="Uninstall Vector" >}} ```shell dpkg -r vector-{{< version >}}-{arch} ``` {{< /tab >}} {{< /tabs >}} {{< jump "/docs/administration/management" "apt-dpkg-rpm-yum-pacman" >}}
Project: Checkmk (Observability and Analysis / Observability)
File: 16464.md

key | value | date | 2024-01-22T17:36:29+00:00 version | 2.3.0b1 class | fix edition | cre component | wato level | 1 compatible | yes During the update config process, the step 'Synchronize automationuser secrets' could fail when a deleted automation user still had its 'var/check_mk/web/' profile present. This werk now correctly resolves this issue.
Project: Hubble (Observability and Analysis / Observability)
File: CONDUCT.md

Cobra will follow a steady release cadence. Non breaking changes will be released as minor versions quarterly. Patch bug releases are at the discretion of the maintainers. Users can expect security patch fixes to be released within relatively short order of a CVE becoming known. For more information on security patch fixes see the CVE section below. Releases will follow . Users tracking the Master branch should expect unpredictable breaking changes as the project continues to move forward. For stability, it is highly recommended to use a release. We will maintain two major releases in a moving window. The N-1 release will only receive bug fixes and security updates and will be dropped once N+1 is released. Deprecation of Go versions or dependent packages will only occur in major releases. To reduce the change of this taking users by surprise, any large deprecation will be preceded by an announcement in the and an Issue on Github. Maintainers will make every effort to release security patches in the case of a medium to high severity CVE directly impacting the library. The speed in which these patches reach a release is up to the discretion of the maintainers. A low severity CVE may be a lower priority than a high severity one. Cobra maintainers will use GitHub issues and the as the primary means of communication with the community. This is to foster open communication with all users and contributors. Breaking changes are generally allowed in the master branch, as this is the branch used to develop the next release of Cobra. There may be times, however, when master is closed for breaking changes. This is likely to happen as we near the release of a new version. Breaking changes are not allowed in release branches, as these represent minor versions that have already been released. These version have consumers who expect the APIs, behaviors, etc, to remain stable during the lifetime of the patch stream for the minor release. Examples of breaking changes include: Removing or renaming exported constant, variable, type, or function. Updating the version of critical libraries such as `spf13/pflag`, `spf13/viper` etc... Some version updates may be acceptable for picking up bug fixes, but maintainers must exercise caution when reviewing. There may, at times, need to be exceptions where breaking changes are allowed in release branches. These are at the discretion of the project's maintainers, and must be carefully considered before merging. Maintainers will ensure the Cobra test suite utilizes the current supported versions of Golang. Changes to this document and the contents therein are at the discretion of the maintainers. None of the contents of this document are legally binding in any way to the maintainers or the users.
Project: Grafana (Observability and Analysis / Observability)
File: bettererIssueTemplate.md

Hi <%= owner %>! The following files have been marked as having issues regarding `<%= issueFilter %>: <%= issueMessageFilter %>`. There are <%= totalIssueCount %> <%= plural('issue', totalIssueCount) %> over <%= fileCount %> <%= plural('file', fileCount) %>: <% files.forEach((file) => { %> [ ] <%= file.issueCount %> <%= plural('issue', file.issueCount) %> in `<%= file.fileName %>` <% }) %>
Project: Prometheus (Observability and Analysis / Observability)
File: https.md

title: HTTPS and authentication sort_rank: 7 Prometheus supports basic authentication and TLS. This is experimental and might change in the future. To specify which web configuration file to load, use the `--web.config.file` flag. The file is written in , defined by the scheme described below. Brackets indicate that a parameter is optional. For non-list parameters the value is set to the specified default. The file is read upon every http request, such as any change in the configuration and the certificates is picked up immediately. Generic placeholders are defined as follows: `<boolean>`: a boolean that can take the values `true` or `false` `<filename>`: a valid path in the current working directory `<secret>`: a regular string that is a secret, such as a password `<string>`: a regular string A valid example file can be found . ``` tlsserverconfig: cert_file: <filename> key_file: <filename> [ clientauthtype: <string> | default = "NoClientCert" ] [ clientcafile: <filename> ] [ clientallowedsans: [ - <string> ] ] [ min_version: <string> | default = "TLS12" ] [ max_version: <string> | default = "TLS13" ] [ cipher_suites: [ - <string> ] ] [ preferservercipher_suites: <boolean> | default = true ] [ curve_preferences: [ - <string> ] ] httpserverconfig: [ http2: <boolean> | default = true ] [ headers: [ Content-Security-Policy: <string> ] [ X-Frame-Options: <string> ] [ X-Content-Type-Options: <string> ] [ X-XSS-Protection: <string> ] [ Strict-Transport-Security: <string> ] ] basicauthusers: [ <string>: <secret> ... ] ```
Project: SkyWalking (Observability and Analysis / Observability)
File: x-process-correlation-headers-v1.md

Version 1.0 SkyWalking Cross Process Correlation Headers Protocol is a new in-wire context propagation protocol which is additional and optional. Please read SkyWalking language agents documentation to see whether it is supported. This is an optional and additional protocol for language tracer implementation. All tracer implementation could consider implementing this. Cross Process Correlation Header key is `sw8-correlation`. The value is the `encoded(key):encoded(value)` list with elements splitted by `,` such as `base64(string key):base64(string value),base64(string key2):base64(string value2)`. The following implementation method is recommended for different language APIs. `TraceContext#putCorrelation` and `TraceContext#getCorrelation` are recommended to write and read the correlation context, with key/value string. The key should be added if it is absent. The latter writes should override the previous value. The total number of all keys should be less than 3, and the length of each value should be less than 128 bytes. The context should be propagated as well when tracing context is propagated across threads and processes.
Project: Headlamp (Observability and Analysis / Observability)
File: lib_k8s_ingressClass.IngressClass.md

title: "Class: IngressClass" linkTitle: "IngressClass" slug: "libk8singressClass.IngressClass" .IngressClass `any` `IngressClass` new IngressClass(`json`) | Name | Type | | : | : | | `json` | | makeKubeObject<KubeIngressClass\>('ingressClass').constructor `Static` apiEndpoint: `Object` | Name | Type | | : | : | | `apiInfo` | { `group`: `string` ; `resource`: `string` ; `version`: `string` }[] | | `delete` | (`name`: `string`, `queryParams?`: , `cluster?`: `string`) => `Promise`<`any`\> | | `get` | (`name`: `string`, `cb`: , `errCb`: , `queryParams?`: , `cluster?`: `string`) => `Promise`<() => `void`\> | | `isNamespaced` | `boolean` | | `list` | (`cb`: , `errCb`: , `queryParams?`: , `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`, `cluster?`: `string`) => `Promise`<`any`\> | | `post` | (`body`: , `queryParams?`: , `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: , `queryParams?`: , `cluster?`: `string`) => `Promise`<`any`\> | _ `Static` className: `string` makeKubeObject<KubeIngressClass\>('ingressClass').className `get` isDefault(): `boolean` `boolean` _ `get` spec(): `Object` `Object` | Name | Type | | : | : | | `controller` | `string` | _ `Static` `get` listRoute(): `string` `string` _ `Static` `get` pluralName(): `string` `string` `Static` apiList(`onList`, `onError?`, `opts?`): `any` | Name | Type | | : | : | | `onList` | (`arg`: `any`[]) => `void` | | `onError?` | (`err`: ) => `void` | | `opts?` | | `any` makeKubeObject<KubeIngressClass\>('ingressClass').apiList _ `Static` `Optional` getAuthorization(`arg`, `resourceAttrs?`): `any` | Name | Type | | : | : | | `arg` | `string` | | `resourceAttrs?` | | `any` makeKubeObject<KubeIngressClass\>('ingressClass').getAuthorization _ `Static` getErrorMessage(`err?`): ``null`` \| `string` | Name | Type | | : | : | | `err?` | ``null`` \| | ``null`` \| `string` makeKubeObject<KubeIngressClass\>('ingressClass').getErrorMessage _ `Static` useApiGet(`onGet`, `name`, `namespace?`, `onError?`): `void` | Name | Type | | : | : | | `onGet` | (...`args`: `any`) => `void` | | `name` | `string` | | `namespace?` | `string` | | `onError?` | (`err`: ) => `void` | `void` makeKubeObject<KubeIngressClass\>('ingressClass').useApiGet _ `Static` useApiList(`onList`, `onError?`, `opts?`): `any` | Name | Type | | : | : | | `onList` | (`arg`: `any`[]) => `void` | | `onError?` | (`err`: ) => `void` | | `opts?` | | `any` makeKubeObject<KubeIngressClass\>('ingressClass').useApiList _ `Static` useGet(`name`, `namespace?`): , (`item`: `any`) => `void`, (`err`: ``null`` \| ) => `void`] | Name | Type | | : | : | | `name` | `string` | | `namespace?` | `string` | , (`item`: `any`) => `void`, (`err`: ``null`` \| ) => `void`] makeKubeObject<KubeIngressClass\>('ingressClass').useGet _ `Static` useList(`opts?`): , (`items`: `any`) => `void`] | Name | Type | | : | : | | `opts?` | | , (`items`: `any`) => `void`] makeKubeObject<KubeIngressClass\>('ingressClass').useList
Project: Grafana (Observability and Analysis / Observability)
File: folder_dashboard_search.md

aliases: ../../httpapi/folderdashboard_search/ canonical: /docs/grafana/latest/developers/httpapi/folderdashboard_search/ description: Grafana Folder/Dashboard Search HTTP API keywords: grafana http documentation api search folder dashboard labels: products: enterprise oss title: Folder/Dashboard Search HTTP API `GET /api/search/` Note: When using , search results will contain only dashboards and folders which you have access to. Query parameters: query Search Query tag List of tags to search for type Type to search for, `dash-folder` or `dash-db` dashboardIds List of dashboard id's to search for dashboardUID - List of dashboard uid's to search for, It is deprecated since Grafana v9.1, please use dashboardUIDs instead dashboardUIDs List of dashboard uid's to search for folderUIDs List of folder UIDs to search in starred Flag indicating if only starred Dashboards should be returned limit Limit the number of returned results (max is 5000; default is 1000) page Use this parameter to access hits beyond limit. Numbering starts at 1. limit param acts as page size. Only available in Grafana v6.2+. Example request for retrieving folders and dashboards at the root level: ```http GET /api/search?query=&starred=false HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` Example response for retrieving folders and dashboards at the root level: ```http HTTP/1.1 200 Content-Type: application/json [ { "id": 163, "uid": "000000163", "title": "Folder", "url": "/dashboards/f/000000163/folder", "type": "dash-folder", "tags": [], "isStarred": false, "uri":"db/folder" // deprecated in Grafana v5.0 }, { "id":1, "uid": "cIBgcSjkk", "title":"Production Overview", "url": "/d/cIBgcSjkk/production-overview", "type":"dash-db", "tags":[prod], "isStarred":true, "uri":"db/production-overview" // deprecated in Grafana v5.0 } ] ``` Example request searching for dashboards: ```http GET /api/search?query=Production%20Overview&starred=true&tag=prod HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ``` Example response searching for dashboards: ```http HTTP/1.1 200 Content-Type: application/json [ { "id":1, "uid": "cIBgcSjkk", "title":"Production Overview", "url": "/d/cIBgcSjkk/production-overview", "type":"dash-db", "tags":[prod], "isStarred":true, "folderId": 2, "folderUid": "000000163", "folderTitle": "Folder", "folderUrl": "/dashboards/f/000000163/folder", "uri":"db/production-overview" // deprecated in Grafana v5.0 } ] ```
Project: HertzBeat (Observability and Analysis / Observability)
File: mysql.md

id: mysql title: MonitoringMySQL database monitoring sidebar_label: MySQL database keywords: [open source monitoring tool, open source database monitoring tool, monitoring mysql database metrics] Collect and monitor the general performance Metrics of MySQL database. Support MYSQL5+. | Parameter name | Parameter help description | ||| | Monitoring Host | Monitored IPV4, IPV6 or domain name. NoteWithout protocol header (eg: https://, http://) | | Monitoring name | Identify the name of this monitoring. The name needs to be unique | | Port | Port provided by the database. The default is 3306 | | Query timeout | Set the timeout time when SQL query does not respond to data, unit: ms, default: 3000ms | | Database name | Database instance name, optional | | Username | Database connection user name, optional | | Password | Database connection password, optional | | URL | Database connection URLoptionalIf configured, the database name, user name, password and other parameters in the URL will overwrite the above configured parameters | | Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds | | Whether to detect | Whether to detect and check the availability of monitoring before adding monitoring. Adding and modifying operations will continue only after the detection is successful | | Description remarks | For more information about identifying and describing this monitoring, users can note information here | | Metric name | Metric unit | Metric help description | | -- | -- | -- | | version | none | Database version | | port | none | Database exposure service port | | datadir | none | Database storage data disk address | | max_connections | none | Database maximum connections | | Metric name | Metric unit | Metric help description | | -- | -- | -- | | threads_created | none | MySql created total connections | | threads_connected | none | MySql connected connections | | threads_cached | none | MySql current cached connections | | threads_running | none | MySql current active connections | | Metric name | Metric unit | Metric help description | | -- | -- | -- | | innodbdatareads | none | innodb average number of reads from files per second | | innodbdatawrites | none | innodb average number of writes from file per second | | innodbdataread | KB | innodb average amount of data read per second | | innodbdatawritten | KB | innodb average amount of data written per second |
Project: Netis (Observability and Analysis / Observability)
File: DOCKER.md

We support docker for packet-agent. In this mode, you can attach packet-agent container to another with shared network card, without intrude into another docker to install packet-agent. You can build docker image from docker/Dockerfile. Build docker image. Now we use centos:6 as base image. ```shell [deploy@localhost docker]$ docker build -f Dockerfile -t centos-packet-agent:v1 . [deploy@localhost docker]$ docker images REPOSITORY TAG IMAGE ID CREATED SIZE centos-packet-agent v1 06472824fd4a 8 seconds ago 262.7 MB ``` Run docker container. The container with packet-agent should share network card with first one(running the application which packet-agent monitor.) ```shell [deploy@localhost ~]# docker run -itd centos:6 /bin/bash <CONTAINER HASH ID> [deploy@localhost ~]# docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES f03b1a137e06 centos:6 "/bin/bash" 16 minutes ago Up 16 minutes high_carson [deploy@localhost ~]# docker run -itd --privileged=true --network=container:high_carson centos-packet-agent:v1 /bin/bash <CONTAINER HASH ID> [deploy@localhost ~]# docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES a6dc13dbf2f0 centos-packet-agent:v1 "/bin/bash" 2 minutes ago Up 2 minutes clever_swirles f03b1a137e06 centos:6 "/bin/bash" 18 minutes ago Up 18 minutes high_carson ``` Log into container with packet-agent. ```shell [deploy@localhost ~]# docker attach clever_swirles [root@6b47b08a55d3 /]# ifconfig eth0 promisc [root@6b47b08a55d3 /]# pktminerg -i eth0 -r 172.16.1.201 ```
Project: Netdata (Observability and Analysis / Observability)
File: x509check_days_until_expiration.md

This alert indicates that your X.509 certificate will expire soon. By default, it is triggered in a warning state when your certificate has less than 14 days to expire and in a critical state when it has less than 7 days to expire. However, these levels are configurable. An X.509 certificate is a digital certificate used to manage identity and security in internet communications and computer networking. If your certificate expires, your system may encounter security and authentication issues which can disrupt your services. Step 1: Check the certificate's expiration details To check the details of your X.509 certificate, including its expiration date, run the following command: ``` openssl x509 -in path/to/your/certificate.crt -text -noout ``` Replace `path/to/your/certificate.crt` with the path to your X.509 certificate file. Step 2: Renew or re-key the certificate If your X.509 certificate is issued by a Certification Authority (CA), you need to renew or re-key the certificate before it expires. The process for renewing or re-keying your certificate depends on your CA. Refer to your CA's documentation or help resources for guidance. Examples of popular CAs include: Step 3: Update your system with the new certificate After renewing or re-keying your certificate, you need to update your system with the new certificate file. The process for updating your system depends on the services and platforms you are using. Refer to their documentation for guidance on how to update your certificate. Step 4: Verify the new certificate Ensure that your system is running with the updated certificate by checking its details again, as described in Step 1. If there are still issues or the alert persists, double-check your certificate management process and consult your CA's documentation for any additional help or support.
Project: Checkmk (Observability and Analysis / Observability)
File: 16586.md

key | value | date | 2024-03-27T09:40:30+00:00 version | 2.4.0b1 class | fix edition | cre component | wato level | 1 compatible | yes Before this Werk, when running the scheduled network scan for a folder it failed with the message "An exception occured: Invalid username: 'Network scan'". This Werk fixes that problem and now the network scan runs correctly with the configured user.