cwielenb/CNCF-Dataset huggingface dataset:
Project: Grafana Loki (Observability and Analysis / Observability)
File: structured_metadata.md

title: structured_metadata description: The 'structured_metadata' Promtail pipeline stage The `structured_metadata` stage is an action stage that takes data from the extracted map and modifies the that is sent to Loki with the log entry. {{% admonition type="warning" %}} Structured metadata will be rejected by Loki unless you enable the `allowstructuredmetadata` per tenant configuration (in the `limits_config`). Structured metadata was added to chunk format V4 which is used if the schema version is greater or equal to 13. (See Schema Config for more details about schema versions. ) {{% /admonition %}} ```yaml structured_metadata: [ <string>: [<string>] ... ] ``` For the given pipeline: ```yaml json: expressions: stream: stream traceID: traceID labels: stream: structured_metadata: traceID: ``` Given the following log line: ```json {"log":"log message\n","stream":"stderr","traceID":"0242ac120002","time":"2019-04-30T02:12:41.8443515Z"} ``` The first stage would extract `stream` with a value of `stderr` and `traceID` with a value of `0242ac120002` into the extracted data set. The `labels` stage would turn that `stream` and `stderr` key-value pair into a stream label. The `structured_metadata` stage would attach the `traceID` and `0242ac120002` key-value pair as a structured metadata to the log line. For the configuration below, you can use labels from `relabelconfigs` to use as `structuredmetadata`: ```yaml pipeline_stages: structured_metadata: pod_uid: podhostip: relabel_configs: action: replace source_labels: metakubernetespod_uid targetlabel: poduid action: replace source_labels: metakubernetespodhostip targetlabel: podhost_ip ``` Given the following discovered labels below with a log line `sample log`: |- Discovered label |- Value |- Target label | | - | - | - | | metakubernetespodhostip | 127.0.0.1 | podhostip | | metakubernetespoduid | b3937321-fe90-4e15-ac94-495c8fdb9202 | poduid | The `structuredmetadata` stage would turn the discovered labels `poduid` and `podhostip` into key-value pairs as structured metadata for the log line `sample log` and exclude them from creating high-cardinality streams.
Project: Thanos (Observability and Analysis / Observability)
File: CODE_OF_CONDUCT.md

Thanos follows the . Additionally our team members can be contacted directly for code of conduct abuse, as described below. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team members (e.g @bwplotka, @povilasv) at . The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. This Code of Conduct is adapted from the , version 1.4, available at
Project: Checkmk (Observability and Analysis / Observability)
File: 16554.md

key | value | compatible | yes version | 2.4.0b1 date | 2024-04-19T12:35:12+00:00 level | 1 class | fix component | checks edition | cre This is a regression since Checkmk 2.2.0. When configuring the Service Monitoring Rule "Filesystems (used space and growth)", configured levels for free space were evaluated incorrectly. As a result, affected services erroneously showed up as CRIT. This happened because of a wrong rounding while evaluating the levels, and only affected small filesystems with a size below 1MB.
Project: Logging Operator (Kube Logging) (Observability and Analysis / Observability)
File: tagnormaliser.md

title: Tag Normaliser weight: 200 generated_file: true More info at https://github.com/kube-logging/fluent-plugin-tag-normaliser | Parameter | Description | Example | |--|-|| | `${pod_name}` | Pod name | understood-butterfly-logging-demo-7dcdcfdcd7-h7p9n | | `${container_name}` | Container name inside the Pod | logging-demo | | `${namespace_name}` | Namespace name | default | | `${pod_id}` | Kubernetes UUID for Pod | 1f50d309-45a6-11e9-b795-025000000001 | | `${labels}` | Kubernetes Pod labels. This is a nested map. You can access nested attributes via `.` | `{"app":"logging-demo", "pod-template-hash":"7dcdcfdcd7" }` | | `${host}` | Node hostname the Pod runs on | docker-desktop | | `${docker_id}` | Docker UUID of the container | 3a38148aa37aa3... | Re-Tag log messages info at Default: ${namespacename}.${podname}.${container_name} Tag used in match directive. Default: `kubernetes.` {{< highlight yaml >}} apiVersion: logging.banzaicloud.io/v1beta1 kind: Flow metadata: name: demo-flow spec: filters: tag_normaliser: format: cluster1.${namespacename}.${podname}.${labels.app} selectors: {} localOutputRefs: demo-output {{</ highlight >}} Fluentd config result: {{< highlight xml >}} <match kubernetes.> @type tag_normaliser @id testtagnormaliser format cluster1.${namespacename}.${podname}.${labels.app} </match> {{</ highlight >}}
Project: Vector (Observability and Analysis / Observability)
File: 2022-05-24-vrl-encryption.md

date: "2022-05-24" title: "New encryption functions for VRL" description: "Encrypt and decrypt data in VRL" authors: ["jszwedko"] pr_numbers: [] release: "0.22.0" hideonrelease_notes: false badges: type: enhancement VRL now contains facilities for encrypting and decrypting field values using encryption with user provided keys via new and functions. A function was added to make it easy to generate initialization vectors for the function. These can be useful to: Decrypt encrypted data that is sent to Vector for processing Encrypting sensitive fields in Vector for storage in an external service that can be decrypted on-demand if the original value is required To encrypt data in VRL with an encryption key you can provide an encryption key. Typically the key is injected via an environment variable. An example with input: ```json { "plaintext": "super secret message" } ``` ```coffeescript key = decodebase64!(getenv_var!("KEY")) # with $KEY set to "c2VjcmV0X19faHVudGVyMg==" in this example .iv = "1234567890123456" # typically you would call random_bytes(<num bytes expected by algorithm>) encrypted_message = encrypt!(plaintext, "AES-128-CBC-PKCS7", key, iv: iv) .encryptedmessage = encodebase64(encrypted_message) del(.plaintext) ``` The result will be: ```json { "encrypted_message": "jYn3wFE2ajfd/VpDE/SrLO5+DknxB3hqgjH5+hpnSu4=" } ``` To decrypt data in VRL with an encryption key you can provide an encryption key (typically injected via an environment variable). An example with input (from above encryption example): ```json { "encrypted_message": "jYn3wFE2ajfd/VpDE/SrLO5+DknxB3hqgjH5+hpnSu4=", "iv": "1234567890123456"} ``` ```text key = decodebase64!(getenv_var!("KEY")) # with $KEY set to "c2VjcmV0X19faHVudGVyMg==" .message = decrypt!(decodebase64!(.encryptedmessage), "AES-128-CBC-PKCS7", key, iv: .iv) del(.iv) del(.encrypted_message) ``` The result will be: ```json { "message": "super secret message" } ``` We hope users will find these new encryption functions useful for dealing with sensitive data in Vector! If you have any feedback for us, whether it's related to the new disk buffers or anything else, let us know on [Discord] or on [Twitter].
Project: Checkmk (Observability and Analysis / Observability)
File: 16414.md

key | value | date | 2024-03-18T13:59:16+00:00 version | 2.4.0b1 class | fix edition | cre component | notifications level | 1 compatible | yes In Werk #6417, we announced that some changes to `etc/check_mk/conf.d/wato/contacts.mk` are necessary before updating. In case a user did not migrate his configuration, they would encounter the following crash in 2.2.0, but not in 2.1.0: ``` File "/omd/sites/edding/lib/python3/cmk/base/notify.py", line 968, in rbnrulecontacts if disablenotificationsopts.get("disable", False): ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AttributeError: 'bool' object has no attribute 'get' ``` With this Werk, the configuration is migrated automatically.
Project: PowerfulSeal (Observability and Analysis / Chaos Engineering)
File: mixing-nodes-pods.md

layout: default title: Mixing nodes and pods description: "" permalink: /mixing-nodes-and-pods parent: Writing policies nav_order: 6 {: .no_toc } {: .no_toc .text-delta } TOC {:toc} A single scenario can have actions on both nodes and pods (don't forget to configure a cloud driver). For example, imagine that you have a service which resolves to a daemonset, and you want to check that the service won't return an error if a node is taken down. ```yaml scenarios: name: Check service responds when one node lost steps: nodeAction: matches: property: name: "name" value: ".master." filters: property: name: "state" value: "UP" randomSample: size: 1 actions: stop: force: false probeHTTP: target: service: name: myservice namespace: example port: 8000 count: 100 ```
Project: Krkn (Observability and Analysis / Chaos Engineering)
File: performance_dashboards.md

Kraken supports installing a mutable grafana on the cluster with the dashboards loaded to help with monitoring the cluster for things like resource usage to find the outliers, API stats, Etcd health, Critical alerts etc. It can be deployed by enabling the following in the config: ``` performance_monitoring: deploy_dashboards: True ``` The route and credentials to access the dashboards will be printed on the stdout before Kraken starts creating chaos. The dashboards can be edited/modified to include your queries of interest. NOTE: The dashboards leverage Prometheus for scraping the metrics off of the cluster and currently only supports OpenShift since Prometheus is setup on the cluster by default and leverages routes object to expose the grafana dashboards externally.
Project: Elastic (Observability and Analysis / Observability)
File: round.md

<!-- This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it. --> Rounds a number to the specified number of decimal places. Defaults to 0, which returns the nearest integer. If the precision is a negative number, rounds to the number of digits left of the decimal point. ``` FROM employees | KEEP firstname, lastname, height | EVAL height_ft = ROUND(height * 3.281, 1) ```
Project: Checkmk (Observability and Analysis / Observability)
File: 16694.md

key | value | compatible | yes version | 2.4.0b1 date | 2024-04-09T09:59:29+00:00 level | 1 class | fix component | multisite edition | cre For the dashlet "Event statistics" you were able to configure "Host" and "Service" Context/Search filter. The "Service" filter had no effect and is now replaced with the "Event Console event" filter option.
Project: Checkmk (Observability and Analysis / Observability)
File: 16505.md

key | value | date | 2024-02-14T09:35:02+00:00 version | 2.4.0b1 class | feature edition | cre component | checks level | 1 compatible | yes This werk adds a service to monitor the total utilization of reserved resources analogous to the reservation utilization graph in the AWS cost explorer. This service is discovered as soon as the AWS agent rule to monitor costs and usage (CE) is enabled.
Project: HertzBeat (Observability and Analysis / Observability)
File: hbase_master.md

id: hbase_master title: Monitoring Hbase Master sidebar_label: HbaseMaster Monitoring keywords: [Open Source Monitoring System, Open Source Database Monitoring, HbaseMaster Monitoring] Collect monitoring data for general performance metrics of Hbase Master. Protocol: HTTP Check the `hbase-site.xml` file to obtain the value of the `hbase.master.info.port` configuration item, which is used for monitoring. | Parameter Name | Parameter Description | | - | -- | | Target Host | The IPv4, IPv6, or domain name of the monitored peer. Note: without protocol header (e.g., https://, http://). | | Port | The port number of the Hbase master, default is 16010. That is, the value of the`hbase.master.info.port` parameter. | | Task Name | The name identifying this monitoring, which needs to be unique. | | Query Timeout | Set the connection timeout in ms, the default is 3000 milliseconds. | | Collection Interval | The periodic collection interval for monitoring data, in seconds, with the minimum allowable interval being 30 seconds. | | Probe | Whether to probe and check the availability of monitoring before adding new monitoring, and proceed with the addition or modification operation only if the probe is successful. | | Description | Additional notes and descriptions for this monitoring, users can add notes here. | | Metric Name | Unit | Metric Description | | -- | - | | | numRegionServers | none | Number of currently alive RegionServers | | numDeadRegionServers | none | Number of currently dead RegionServers | | averageLoad | none | Cluster average load | | clusterRequests | none | Total number of cluster requests | | Metric Name | Unit | Metric Description | | -- | - | -- | | ritnone | none | Current number of RIT | | ritnoneOverThreshold | none | Number of RIT over the threshold | | ritOldestAge | ms | Duration of the oldest RIT | | Metric Name | Unit | Metric Description | | -- | - | - | | liveRegionServers | none | List of currently active RegionServers | | deadRegionServers | none | List of currently offline RegionServers | | zookeeperQuorum | none | Zookeeper list | | masterHostName | none | Master node | | BalancerClusternumops | none | Number of cluster load balancing operations | | numActiveHandler | none | Number of RPC handlers | | receivedBytes | MB | Cluster received data volume | | sentBytes | MB | Cluster sent data volume (MB) | | clusterRequests | none | Total number of cluster requests |
Project: Netdata (Observability and Analysis / Observability)
File: upsd_ups_battery_charge.md

The `upsdupsbattery_charge` alert indicates that the average UPS charge over the last minute has dropped below a predefined threshold. This might be due to a power outage, a UPS malfunction, or a sudden surge in power demands that the UPS can't handle. Check UPS status and connections Inspect the UPS physical connections, including power cables, communication cables, and any other devices connected to it. Ensure that everything is plugged in correctly and firmly. Check UPS logs and error messages Review the UPS logs for any error messages or events that might have occurred around the time the alert was triggered. This information could help you pinpoint the cause of the issue. You can find the logs in the Network UPS Tools (NUT) software. Monitor UPS charge level Keep an eye on the UPS charge level to determine if it's increasing or decreasing. This information can help you understand the overall health of your UPS. Test UPS batteries Test the UPS batteries to ensure that they are functioning correctly and have enough charge to power your devices during a power outage. Replace any faulty batteries or upgrade to higher-capacity batteries if needed. Check the UPS load Review the devices connected to the UPS and calculate their total power consumption. Ensure that the UPS is not overloaded and is capable of supporting the power demands of your devices. Restore the power supply If the UPS charge level remains low, try restoring the power supply to your UPS. This could involve switching to a different power source, fixing any faulty connections, or resolving issues with your local power grid. Prepare for a graceful shutdown If you can't restore the power supply to this UPS or if the problem persists,prepare your machine for a graceful shutdown to minimize the risk of data loss or hardware damage.
Project: Flagsmith (Observability and Analysis / Feature Flagging)
File: flag-management.md

Managing larger numbers of flags is made easier using some of the tools built into Flagsmith. You can create tags within Flagsmith and tag Flags in order to organise them. Tags can also be used to filter the list of Flags in the event that you have a large number. :::info Protected Tags Tags with the following names will prevent users from being able to delete tagged Flags via the dashboard: `protected` `donotdelete` `permanent` ::: When creating a flag, you can optionally define it as "Server-Side Only". Enabling this option for the flag will prevent it from being returned to Client-side SDKs. To prevent letting your users know about your upcoming features and to cut down on payload, enabling this will prevent the API from returning any flags that are disabled. You can set this at both the Project and Environment level. You can also archive Flags within Flagsmith. Archived flags will continue to be sent to your SDKs when you get the flags for your Environment, but by default they are hidden from the main list of flags. You can set a Flag as Archived from the Flag settings tab. Archived flags are often used when you have customers running older versions of your mobile app. You may well have finished with a flag, but you can't remove it as there are still some older versions of your app out there that depend on that flag. Archiving the flag helps to keep your main list of flags under control. By default, Flagsmith stores flags with lower case characters in order to minimise human error. If you want to store flags in a case-sensitive manner you can do this as a Project-wide setting from the Project Settings page. :::tip We don't recommend making your Flags case sensitive. This can lead to bugs related to case sensitivity and flags not being found at runtime. ::: You can enforce feature name String formatting by way of a regular expression in the Project Settings area. If you want flags to always be lower case, or camel case, or whatever your preference, you can set it here. You can specify members of your team as owners of individual Flags. This helps in larger teams when you need to identify who is responsible for a particular flag. By default, when you create a feature with a value and enabled state it acts as a default for your other Environments. In the Project Settings page, you have the option of enabling the setting 'Prevent flag defaults' to prevent this behaviour. When this setting is enabled the user is not able to provide defaults when creating the feature. The feature will be created with an empty value and will be turned off in all environments. Users are then required to modify the state / value of the feature in each environment individually. You can compare Flags both across Environments and for individual Flags. Use the "Compare" menu item to get an overview of how flag values differ between any two Environments: You can also view a the values of a single Flag against all the Environments within the Project:
Project: Netdata (Observability and Analysis / Observability)
File: riakkv_list_keys_active.md

This alert indicates that currently there are active `list keys` operations in Finite State Machines (FSM) on your Riak KV database. Running `list keys` in Riak is a resource-intensive operation and can significantly affect the performance of the cluster, and it is not recommended for production use. `List keys` operations in Riak involve iterating through all keys in a bucket to return a list of keys. The reason this is expensive in terms of resources is that Riak needs to traverse the entire dataset to generate a list of keys. As the dataset grows, the operation consumes more resources and takes longer to process the list, which can lead to reduced performance and scalability. To address the `riakkvlistkeys_active` alert, follow these steps: Identify the processes and applications running `list keys` operations: Monitor your application logs and identify the processes or applications that are using these operations. You may need to enable additional logging to capture information related to `list keys`. Evaluate the necessity of `list keys` operations: Work with your development team and determine if there's a specific reason these operations are being used. If they are not necessary, consider replacing them with other, more efficient data retrieval techniques. Optimize data retrieval: If it is necessary to retrieve keys in your application, consider using an alternative strategy such as Secondary Indexes (2i) or implementing a custom solution tailored to your specific use case. Monitor the system: After making changes to your application, continue monitoring the active list key FSMs using Netdata to ensure that the number of active list keys operations is reduced.
Project: Checkmk (Observability and Analysis / Observability)
File: 16445.md

key | value | date | 2024-01-24T11:35:45+00:00 version | 2.3.0b1 class | fix edition | cre component | inv level | 1 compatible | yes Fix missing retention information in views with HW/SW inventory columns. Do not display retention icon if retention information is valid but not outdated.
Project: Headlamp (Observability and Analysis / Observability)
File: plugin_registry.EventListEvent.md

title: "Interface: EventListEvent" linkTitle: "EventListEvent" slug: "plugin_registry.EventListEvent" .EventListEvent Event fired when kubernetes events are loaded (for a resource or not). data: `Object` | Name | Type | Description | | : | : | : | | `events` | [] | The list of events that were loaded. | | `resource?` | `any` | The resource for which the events were loaded. | _ type: `OBJECT_EVENTS`
Project: Elastic (Observability and Analysis / Observability)
File: to_cartesianpoint.md

<!-- This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it. --> Converts an input value to a `cartesian_point` value. A string will only be successfully converted if it respects WKT Point format. ``` ROW wkt = ["POINT(4297.11 -1475.53)", "POINT(7580.93 2272.77)"] | MV_EXPAND wkt | EVAL pt = TO_CARTESIANPOINT(wkt) ```
Project: Graylog (Observability and Analysis / Observability)
File: BrandIcon.md

Examples: ```js <p> <strong>Brand icons:</strong>{' '} <BrandIcon name="apple" />{' '} <BrandIcon name="freebsd" />{' '} <BrandIcon name="github" />{' '} <BrandIcon name="linux" />{' '} <BrandIcon name="windows" /> </p> ```
Project: Headlamp (Observability and Analysis / Observability)
File: lib_k8s_secret.KubeSecret.md

title: "Interface: KubeSecret" linkTitle: "KubeSecret" slug: "libk8ssecret.KubeSecret" .KubeSecret `KubeSecret` `Optional` apiVersion: `string` . _ data: _ 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: . _ type: `string`