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

title: "Fetching and querying" menuTitle: "Query Fanout" weight: 2 Since m3query does not currently have a view into the M3DB index, fanout to multiple clusters is rather complicated. Since not every metric is necessarily in every cluster (as an example, carbon metrics routed to a certain resolution), it is not trivial to determine which namespaces should be queried to return a fully correct set of recorded metrics. The general approach is therefore to attempt to fanout to any namespace which has a complete view of all metrics, for example, `Unaggregated`, and take that if it fulfills the query range; if not, m3query will attempt to stitch together namespaces with longer retentions to try and build the most complete possible view of stored metrics.
Project: Kuberhealthy (Observability and Analysis / Observability)
File: PROMETHEUS.md

Kuberhealthy serves Prometheus metrics at the `/metrics` endpoint. If you are using the to deploy Kuberhealthy, enable Prometheus in the chart options to have scrape configs and annotations generated for you. ```bash helm install kuberhealthy kuberhealthy/kuberhealthy --set prometheus.enabled=true --set prometheus.prometheusRule.enabled=true ``` Alternatively, you can use the static files that are generated from the helm chart auotmatically whenever the chart changes .
Project: Headlamp (Observability and Analysis / Observability)
File: lib_k8s_podDisruptionBudget.KubePDB.md

title: "Interface: KubePDB" linkTitle: "KubePDB" slug: "libk8spodDisruptionBudget.KubePDB" .KubePDB `KubePDB` `Optional` apiVersion: `string` . _ kind: `string` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. In CamelCase. Cannot be updated. `see` . _ metadata: . _ spec: `Object` | Name | Type | | : | : | | `maxUnavailable?` | `number` | | `minAvailable?` | `number` | | `selector` | { `matchExpressions?`: { `key`: `string` ; `operator`: `string` ; `values`: `string`[] } ; `matchLabels`: { `[key: string]`: `string`; } } | | `selector.matchExpressions?` | { `key`: `string` ; `operator`: `string` ; `values`: `string`[] } | | `selector.matchExpressions.key` | `string` | | `selector.matchExpressions.operator` | `string` | | `selector.matchExpressions.values` | `string`[] | | `selector.matchLabels` | { `[key: string]`: `string`; } | _ status: `Object` | Name | Type | | : | : | | `conditions` | { `lastTransitionTime`: `string` ; `message`: `string` ; `observedGeneration`: `number` ; `reason`: `string` ; `status`: `string` ; `type`: `string` }[] | | `currentHealthy` | `number` | | `desiredHealthy` | `number` | | `disruptedPods?` | { `[key: string]`: `string`; } | | `disruptionsAllowed` | `number` | | `expectedPods` | `number` | | `observedGeneration` | `number` |
Project: Vector (Observability and Analysis / Observability)
File: 2021-02-16-swimlanes-remap-support.md

date: "2021-02-16" title: "Remap support for the `swimlanes` transform (routing)" description: "Use VRL to specify conditions for routing events into multiple channels" authors: ["lucperkins"] pr_numbers: [] release: "0.12.0" hideonrelease_notes: false badges: type: "enhancement" transforms: ["swimlanes"] The transform for Vector enables you to route events into multiple named channels, or lanes, based on supplied conditions. This can be useful for use cases like sending a subset of events to one sink and a different subset to another. Previously, the `swimlanes` transform required you to specify conditions using `check_fields`. But now you can use Vector Remap Language expressions in the transform to specify those conditions. This should make using `swimlanes` more natural and expressive. The example configuration below shows the same `swimlanes` transform using the old system (`check_fields`) and the new system (`remap`): ```diff [transforms.split_events] type = "swimlanes" inputs = ["http-server-logs"] -lanes.success.type = "check_fields" -lanes.success.status_code.eq = 200 -lanes.success.severity.eq = "info" +lanes.success.type = "remap" +lanes.success.source = '.status_code == 200 && .severity == "info"' ```
Project: Vector (Observability and Analysis / Observability)
File: yum.md

title: Install Vector using YUM short: YUM weight: 9 The (YUM) is a free and open-source command-line package-manager for Linux operating system using the RPM Package Manager. Our Yum repositories are provided by [Datadog]. This page covers installing and managing Vector through the YUM package repository. Add the repo: ```shell bash -c "$(curl -L https://setup.vector.dev)" ``` Then you can install Vector: ```shell sudo yum install vector ``` {{< tabs default="Upgrade Vector" >}} {{< tab title="Upgrade Vector" >}} ```shell sudo yum upgrade vector ``` {{< /tab >}} {{< tab title="Uninstall Vector" >}} ```shell sudo yum remove vector ``` {{< /tab >}} {{< /tabs >}} {{< jump "/docs/administration/management" "apt-dpkg-rpm-yum-pacman" >}}
Project: HertzBeat (Observability and Analysis / Observability)
File: alert_slack.md

id: alert_slack title: Alert Slack Webhook Notifications sidebar_label: Alert Slack Webhook Notification keywords: [open source monitoring tool, open source alerter, open source slack webhook notification] Send an alarm message after the threshold is triggered, and notify the recipient through the Slack Webhook. Refer to the official website document Alarm Notification->Add Recipient->Select Slack Webhook Notification Method->Set Webhook URL-> OK Configure the associated alarm notification strategy [Add notification strategy] -> [Associate the recipient just set] -> [OK] Note Adding a new recipient does not mean that it has taken effect and can receive alarm information. It is also necessary to configure the associated alarm notification strategy, that is, specify which messages are sent to which recipients. Slack did not receive the robot warning notification Please check whether the alarm information has been triggered in the alarm center Please check whether the slack webhook url are configured correctly, and whether the alarm policy association has been configured Other questions can be fed back through the communication group ISSUE!
Project: Vector (Observability and Analysis / Observability)
File: 2020-04-09-make-acl-optional.md

date: "2020-07-13" title: "ACL is now optional for the Google Cloud Storage sink" description: "ACL isn't always required when creating objects in GCP Cloud Storage" authors: ["binarylogic"] hideonrelease_notes: false pr_numbers: [2283] release: "0.9.0" badges: type: "breaking change" domain: ["sinks"] sinks: ["gcpcloudstorage"] GCP Cloud Storage buckets with don't support setting ACL for objects inside them (HTTP 400 error is returned). Therefore, the Vector `gcpcloudstorage` sink no longer supplies a `x-goog-acl` header by default. If you wish to set an ACL for your GCP object you'll need to explicitly set the `acl` option: ```diff title="vector.toml" [sinks.gcpcloudstorage] type = "gcpcloudstorage" acl = "projectPrivate" # change as desired ``` That's it!
Project: Netdata (Observability and Analysis / Observability)
File: azure.md

<!-- title: "Install Netdata on Azure" description: "The Netdata Agent runs on all popular cloud providers, but often requires additional steps and configuration for full functionality." customediturl: https://github.com/netdata/netdata/edit/master/packaging/installer/methods/azure.md sidebar_label: "Azure" learn_status: "Published" learnrelpath: "Installation/Install on specific environments" --> Netdata is fully compatible with Azure. You can install Netdata on cloud instances to monitor the apps/services running there, or use multiple instances in a configuration. The best installation method depends on the instance's operating system, distribution, and version. For Linux instances, we recommend the . If you have issues with Netdata after installation, look to the sections below to find the issue you're experiencing, followed by the solution for your provider. If you cannot access Netdata's dashboard on your cloud instance via `http://HOST:19999`, and instead get an error page from your browser that says, "This site can't be reached" (Chrome) or "Unable to connect" (Firefox), you may need to configure your cloud provider's firewall. Cloud providers often create network-level firewalls that run separately from the instance itself. Both AWS and Google Cloud Platform calls them Virtual Private Cloud (VPC) networks. These firewalls can apply even if you've disabled firewalls on the instance itself. Because you can modify these firewalls only via the cloud provider's web interface, it's easy to overlook them when trying to configure and access Netdata's dashboard. You can often confirm a firewall issue by querying the dashboard while connected to the instance via SSH: `curl http://localhost:19999/api/v1/info`. If you see JSON output, Netdata is running properly. If you try the same `curl` command from a remote system, and it fails, it's likely that a firewall is blocking your requests. Another option is to put Netdata behind web server, which will proxy requests through standard HTTP/HTTPS ports (80/443), which are likely already open on your instance. We have a number of guides available: Sign in to the and open the virtual machine running Netdata. Click on the Networking link beneath the Settings header, then click on the Add inbound security rule button. Add a new rule with the following options: ```conf Source: Any Source port ranges: 19999 Destination: Any Destination port ranges: 19999 Protocol: TCP Action: Allow Priority: 310 Name: Netdata ``` Click Add to apply your new inbound security rule.
Project: Headlamp (Observability and Analysis / Observability)
File: lib_k8s_clusterRole.ClusterRole.md

title: "Class: ClusterRole" linkTitle: "ClusterRole" slug: "libk8sclusterRole.ClusterRole" .ClusterRole `ClusterRole` new ClusterRole(`json`) | Name | Type | | : | : | | `json` | | . `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`\> | . `get` detailsRoute(): `string` `string` _ `get` rules(): `any` `any` Role.rules _ `Static` `get` className(): `string` `string` Role.className `Static` apiList(`onList`, `onError?`, `opts?`): `any` | Name | Type | | : | : | | `onList` | (`arg`: `any`[]) => `void` | | `onError?` | (`err`: ) => `void` | | `opts?` | | `any` . _ `Static` `Optional` getAuthorization(`arg`, `resourceAttrs?`): `any` | Name | Type | | : | : | | `arg` | `string` | | `resourceAttrs?` | | `any` . _ `Static` getErrorMessage(`err?`): ``null`` \| `string` | Name | Type | | : | : | | `err?` | ``null`` \| | ``null`` \| `string` . _ `Static` useApiGet(`onGet`, `name`, `namespace?`, `onError?`): `void` | Name | Type | | : | : | | `onGet` | (...`args`: `any`) => `void` | | `name` | `string` | | `namespace?` | `string` | | `onError?` | (`err`: ) => `void` | `void` . _ `Static` useApiList(`onList`, `onError?`, `opts?`): `any` | Name | Type | | : | : | | `onList` | (`arg`: `any`[]) => `void` | | `onError?` | (`err`: ) => `void` | | `opts?` | | `any` . _ `Static` useGet(`name`, `namespace?`): , (`item`: `any`) => `void`, (`err`: ``null`` \| ) => `void`] | Name | Type | | : | : | | `name` | `string` | | `namespace?` | `string` | , (`item`: `any`) => `void`, (`err`: ``null`` \| ) => `void`] . _ `Static` useList(`opts?`): , (`items`: `any`) => `void`] | Name | Type | | : | : | | `opts?` | | , (`items`: `any`) => `void`] .
Project: Vector (Observability and Analysis / Observability)
File: api.md

title: The Vector API short: API weight: 3 Vector ships with a [GraphQL] API that allows you to interact with a running Vector instance. This page covers how to configure and enable Vector's API. {{< api/config >}} {{< api/endpoints >}} Vector chose [GraphQL] for its API because GraphQL is self-documenting and type safe. We believe that this offers a superior client experience and makes Vector richly programmable through its API. Vector's GraphQL API ships with a built-in playground that allows you to explore the available commands and manually run queries against the API. This can be accessed at the `/playground` path.
Project: Falcon (Observability and Analysis / Observability)
File: 2017-01-01-dashboard_screen_update.md

category: DashboardScreen apiurl: '/api/v1/dashboard/screen/:screen_id' title: 'Update a DashboardScreen' type: 'PUT' sample_doc: 'dashboard.html' layout: default Required Content-type: application/x-www-form-urlencoded ```name=laiwei-sceen1&pid=0``` ```Status: 200``` ```{"message":"ok"} ``` For errors responses, see the .
Project: Grafana (Observability and Analysis / Observability)
File: release-notes-8-2-0.md

_build: list: false labels: products: cloud enterprise oss title: Release notes for Grafana 8.2.0 <!-- Auto generated by update changelog github action --> AWS: Updated AWS authentication documentation. , Alerting: Added support Alertmanager data source for upstream Prometheus AM implementation. , Alerting: Allows more characters in label names so notifications are sent. , Alerting: Get alert rules for a dashboard or a panel using /api/v1/rules endpoints. , Annotations: Improved rendering performance of event markers. , CloudWatch Logs: Skip caching for log queries. , Explore: Added an opt-in configuration for Node Graph in Jaeger, Zipkin, and Tempo. , Packaging: Add stricter systemd unit options. , Prometheus: Metrics browser can now handle label values with special characters. , CodeEditor: Ensure that we trigger the latest onSave callback provided to the component. , DashboardList/AlertList: Fix for missing All folder value. , In Grafana v8.2.0, this change can prevent the `grafana-server` service from starting on older versions of systemd, present on Ubuntu 18.04 and slightly older versions of Debian. If running one of those versions, please wait until v8.2.1 is released before upgrading. If you still want to upgrade or have already upgraded, a simple fix is available here: https://github.com/grafana/grafana/issues/40162#issuecomment-938060240 Issue Plugins: Create a mock icon component to prevent console errors. ,
Project: Netdata (Observability and Analysis / Observability)
File: net.inet.udp.stats.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/integrations/net.inet.udp.stats.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/freebsd.plugin/metadata.yaml" sidebar_label: "net.inet.udp.stats" learn_status: "Published" learnrelpath: "Collecting Metrics/FreeBSD" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/network.svg" width="150"/> Plugin: freebsd.plugin Module: net.inet.udp.stats <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> Collect information about UDP connections. The plugin calls `sysctl` function to collect necessary data. This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics show UDP connections statistics. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | ipv4.udppackets | received, sent | packets/s | | ipv4.udperrors | InErrors, NoPorts, RcvbufErrors, InCsumErrors, IgnoredMulti | events/s | The following alerts are available: | Alert name | On metric | Description | |:|:-|:| | | ipv4.udperrors | average number of UDP receive buffer errors over the last minute | | | ipv4.udperrors | average number of UDP send buffer errors over the last minute | No action required. The configuration file name for this integration is `netdata.conf`. Configuration for this specific integration is located in the `[plugin:freebsd:net.inet.udp.stats]` section within that file. The file format is a modified INI syntax. The general structure is: ```ini [section1] option1 = some value option2 = some other value [section2] option3 = some third value ``` You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config netdata.conf ``` <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | ipv4 UDP packets | Enable or disable ipv4 UDP packets metric. | yes | no | | ipv4 UDP errors | Enable or disable ipv4 UDP errors metric. | yes | no | </details> There are no configuration examples.
Project: Checkmk (Observability and Analysis / Observability)
File: 16164.md

key | value | compatible | yes version | 2.3.0b1 date | 2023-12-29T08:24:59+00:00 level | 1 class | fix component | checks edition | cre Previously, the veeamcdpjobs would crash when receiving last sync time from the future with a message: ``` raise ValueError("Cannot render negative timespan") ``` Now, the affected service will be in state WARN and report the following message: ``` "The timestamp of the file is in the future. Please investigate your host times" ```
Project: Headlamp (Observability and Analysis / Observability)
File: lib_k8s_namespace.KubeNamespace.md

title: "Interface: KubeNamespace" linkTitle: "KubeNamespace" slug: "libk8snamespace.KubeNamespace" .KubeNamespace `KubeNamespace` `Optional` apiVersion: `string` . _ kind: `string` Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. In CamelCase. Cannot be updated. `see` . _ metadata: . _ status: `Object` | Name | Type | | : | : | | `phase` | `string` |
Project: Litmus (Observability and Analysis / Chaos Engineering)
File: state.md

Chaos Schedules can be `halted` or `resumed` as per need. It can tuned via setting `spec.scheduleState` to `halt` and `active` respectively. ??? info "View the state schema" <table> <tr> <th>Field</th> <td><code>.spec.scheduleState</code></td> </tr> <tr> <th>Description</th> <td>Flag to control chaosshedule state </td> </tr> <tr> <th>Type</th> <td>Optional</td> </tr> <tr> <th>Range</th> <td><code>active</code>, <code>halt</code>, <code>complete</code></td> </tr> <tr> <th>Default</th> <td><code>active</code></td> </tr> <tr> <th>Notes</th> <td>The <code>scheduleState</code> is the current state of ChaosSchedule. If the schedule is running its state will be <code>active</code>, if the schedule is halted its state will be <code>halt</code> and if the schedule is completed it state will be <code>complete</code>.</td> </tr> </table> Follow the below steps to halt the active schedule: Edit the ChaosSchedule CR in your favourite editor ``` kubectl edit chaosschedule schedule-nginx ``` Change the spec.scheduleState to halt ``` spec: scheduleState: halt ``` Follow the below steps to resume the halted schedule: Edit the chaosschedule ``` kubectl edit chaosschedule schedule-nginx ``` Change the spec.scheduleState to active ``` spec: scheduleState: active ```
Project: Checkmk (Observability and Analysis / Observability)
File: 16197.md

key | value | date | 2024-02-27T12:11:36+00:00 version | 2.4.0b1 class | fix edition | cre component | checks level | 1 compatible | yes Currently the SNMP detection for `quantumlibsmallstatus` and `quantumlibsmalldoor` checks if "linux" and "library" are contained in the sysDescr and sysLocation OIDs. To make the detection more reliable, the sysObjectID is checked against the linux object identifier and the libraryProductName .1.3.6.1.4.1.3697.1.10.10.1.10.0 against "Quantum Small Library Product".
Project: SkyWalking (Observability and Analysis / Observability)
File: service-auto-grouping.md

SkyWalking supports various default and customized dashboard templates. Each template provides an appropriate layout for services in a particular field. For example, the metrics for services with language agents installed may be different from that of services detected by the service mesh observability solution as well as SkyWalking's self-observability metrics dashboard. Therefore, since version 8.3.0, the SkyWalking OAP has generated the groups based on this simple naming format: If the service name includes double colons (`::`), the literal string before the colons is taken as the group name. In the latest GraphQL query, the group name has been provided as an optional parameter. getAllServices(duration: Duration!, group: String): [Service!]! RocketBot UI dashboards (`Standard` type) support the `group name` for default and custom configurations.
Project: Checkmk (Observability and Analysis / Observability)
File: 16317.md

key | value | compatible | yes version | 2.4.0b1 date | 2024-02-15T07:48:10+00:00 level | 1 class | fix component | bi edition | cre The option should change the computation of downtimes from CRIT to WARN but did not. This has been fixed.
Project: Vector (Observability and Analysis / Observability)
File: msi.md

title: Install Vector using MSI short: MSI weight: 5 MSI is the file format and command line utility for the . Windows Installer (previously known as Microsoft Installer) is an interface for Microsoft Windows that's used to install and manage software on Windows systems. This page covers installing and managing Vector through the MSI package repository. ```powershell powershell Invoke-WebRequest https://packages.timber.io/vector/{{% version %}}/vector-x64.msi -OutFile vector-{{% version %}}-x64.msi msiexec /i vector-{{% version %}}-x64.msi ``` {{< jump "/docs/administration/management" "windows" >}}