cwielenb/CNCF-Dataset huggingface dataset:
Project: Inspektor Gadget (Observability and Analysis / Observability)
File: opensnoop.md

title: Gadget opensnoop opensnoop traces open() system calls ```yaml apiVersion: gadget.kinvolk.io/v1alpha1 kind: Trace metadata: name: opensnoop namespace: gadget spec: node: ubuntu-hirsute gadget: opensnoop runMode: Manual outputMode: Stream filter: namespace: default ``` Start opensnoop gadget ```bash $ kubectl annotate -n gadget trace/opensnoop \ gadget.kinvolk.io/operation=start ``` Stop opensnoop gadget ```bash $ kubectl annotate -n gadget trace/opensnoop \ gadget.kinvolk.io/operation=stop ``` Stream
Project: Vector (Observability and Analysis / Observability)
File: template-syntax.md

title: Template syntax weight: 7 aliases: ["/docs/reference/templates", "/docs/reference/configuration/templates"] Vector supports a template syntax for some configuration options. This allows for dynamic values derived from event data. Any option that supports this syntax will be clearly documented as such in the description. Let's partition data on AWS S3 by "applicationid" and "date". We can accomplish this with the `keyprefix` option in the `aws_s3` sink: ```toml [sinks.backup] type = "aws_s3" bucket = "allapplicationlogs" keyprefix = "applicationid={{ application_id }}/date=%F/" ``` Notice that Vector allows direct field references as well as "strftime" specifiers. If we were to run the following log event through Vector: ```json { "timestamp": "2020-02-14T01:22:23.223Z", "application_id": 1, "message": "Hello world" } ``` The value of the above `key_prefix` option would equal: ```raw application_id=1/date=2020-02-14 ``` Because the sink batches data, each event would be grouped by its produced value. This effectively enables dynamic partitioning, something fundamental to storing log data in filesystems. Individual fields can be accessed using `{{ ... }}` to wrap a VRL : ```toml option = "{{ .parent.child }}" ``` In addition to directly accessing fields, Vector offers a shortcut for injecting : ```toml option = "year=%Y/month=%m/day=%d/" ``` {{< info >}} The value is derived from the and the name of this field can be changed via the . {{< /info >}} You can escape this syntax by prefixing the character with a `\`. For example, you can escape the event field syntax like this: ```toml option = "\{{ field_name }}" ``` And [strftime] specified like so: ```toml option = "year=\%Y/month=\%m/day=\%d/" ``` Each of the values above would be treated literally. You can find additional examples for accessing fields in the documentation. Vector doesn't currently support fallback values, is open to add this functionality. In the interim, you can use the to set a default value: ```toml [transforms.set_defaults] type = "remap" inputs = ["my-source-id"] source = ''' if !exists(.my_field) { .my_field = "default" } ''' ``` If a field is missing, an error is logged and Vector drops the event. The `componenterrorstotal` internal metric is incremented with an `errortype` tag of `templatefailed`.
Project: Netdata (Observability and Analysis / Observability)
File: pihole_status.md

This alert monitors if Pi-hole's ability of blocking unwanted domains is active. If you receive this alert, it means that your Pi-hole's ad filtering is currently disabled. Check the status of Pi-hole To check the current status of Pi-hole, run the following command: ``` pihole status ``` This command will show if Pi-hole is active or disabled. Re-enable Pi-hole If Pi-hole is disabled as per the status, you can re-enable it by running the following command: ``` pihole enable ``` Confirm Pi-hole is enabled After running the previous command, run `pihole status` again to confirm that Pi-hole is now enabled and blocking unwanted domains. Check for errors or warnings If Pi-hole is still not enabled, take a look at the logs for any errors or warnings: ``` cat /var/log/pihole.log | grep -i error cat /var/log/pihole.log | grep -i warning ``` Rebuild the blocklist If you still face issues, you can try rebuilding the blocklist by running: ``` pihole -g ``` Update Pi-hole If the problem persists, consider updating Pi-hole to the latest version: ``` pihole -up ```
Project: Checkmk (Observability and Analysis / Observability)
File: 16306.md

key | value | date | 2024-01-02T09:35:31+00:00 version | 2.3.0b1 class | fix edition | cee component | reporting level | 1 compatible | yes If you exported a view with host- or servicegroup context, an error like "Error while rendering element type" was shown because of missing context information.
Project: Elastic (Observability and Analysis / Observability)
File: st_within.md

<!-- This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it. --> Returns whether the first geometry is within the second geometry. This is the inverse of the <<esql-stcontains,STCONTAINS>> function. ``` FROM airportcityboundaries | WHERE STWITHIN(cityboundary, TO_GEOSHAPE("POLYGON((109.1 18.15, 109.6 18.15, 109.6 18.65, 109.1 18.65, 109.1 18.15))")) | KEEP abbrev, airport, region, city, city_location ```
Project: Vector (Observability and Analysis / Observability)
File: 2020-09-18-adaptive-concurrency.md

date: "2020-09-18" title: "Adaptive Request Concurrency (ARC)" description: "Increasing reliability and performance across your entire observability infrastructure." authors: ["lucperkins"] pr_numbers: [3094] release: "0.11.0" hideonrelease_notes: false badges: type: "new feature" domains: ["networking"] domains: ["performance", "reliability"] Vector 0.11 includes a new Adaptive Request Concurrency (ARC) feature that raises the performance and reliability of your entire observability infrastructure without any changes on your part. In short, it does away with static rate-limits and automatically optimizes HTTP concurrency limits based on downstream service responses. The underlying mechanism is a simple feedback loop inspired by TCP congestion control algorithms. This feature, like all Vector features, will begin its life in public beta and be available on an opt-in basis. To get it, enable it for each sink: ```toml [sinks.my-sink] type = "..." # any http-based sink request.concurrency = "adaptive" ```
Project: Grafana Mimir (Observability and Analysis / Observability)
File: configure-blocked-queries.md

title: Configure queries to block description: Control what queries are sent to your Mimir installation. weight: 100 In certain situations, you might want to control what queries are being sent to your Mimir installation. These queries might be intentionally or unintentionally expensive to run, and they might affect the overall stability or cost of running your service. You can block queries using : ```yaml overrides: "tenant-id": blocked_queries: pattern: 'sum(rate(nodecpuseconds_total{env="prod"}[1m]))' pattern: '.env="prod".' regex: true ``` To set up runtime overrides, refer to . {{% admonition type="note" %}} The order of patterns is preserved, so the first matching pattern will be used. {{% /admonition %}} Use Mimirtool's `mimirtool promql format <query>` command to apply the Prometheus formatter to a query for use in a blocked query `pattern`. Queries received by Mimir are parsed into PromQL expressions before blocking is applied. The `pattern` from the blocked queries is compared against the formatted representation of the parsed query, in order to allow consistent query blocking behavior regardless of formatting differences in the submitted queries. Among other transformations the Prometheus formatter may reorder operators, remove empty selector braces, and eliminate newlines, extraneous whitespace, and comments. Empty selector braces removed: ```bash mimirtool promql format 'foo{}' ``` ```console foo ``` Operators reordered: ```bash mimirtool promql format 'sum(containermemoryrss) by (namespace)' ``` ```console sum by (namespace) (containermemoryrss) ``` Newlines, extra whitespace, and comments eliminated: ```bash mimirtool promql format ' rate( metric_counter[15m] # comment 1 ) / rate( other_counter[15m] # comment 2 ) ' ``` ```console rate(metriccounter[15m]) / rate(othercounter[15m]) ``` Blocked queries are logged, as well as counted in the `cortexqueryfrontendrejectedqueries_total` metric on a per-tenant basis.
Project: Elastic (Observability and Analysis / Observability)
File: ltrim.md

<!-- This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it. --> Removes leading whitespaces from a string. ``` ROW message = " some text ", color = " red " | EVAL message = LTRIM(message) | EVAL color = LTRIM(color) | EVAL message = CONCAT("'", message, "'") | EVAL color = CONCAT("'", color, "'") ```
Project: Vector (Observability and Analysis / Observability)
File: 2020-02-07-multi-config-files.md

date: "2020-04-13" title: "Support For Multiple Config Files" description: "A better way to manage complex Vector configurations" authors: ["binarylogic"] pr_numbers: [1725] release: "0.8.0" hideonrelease_notes: false badges: type: "new feature" domains: ["config"] Vector is now able to execute a topology spread across multiple config files, which allows you to break large pipelines down into bite size, easier managed, chunks. Running them is as simple as: ```bash vector -c ./configs/first.toml -c ./configs/second.toml -c ./more/*.toml ``` and you'll be notified when we learn how to do this with human emotions.
Project: Grafana Loki (Observability and Analysis / Observability)
File: patch-go-version.md

title: Patch Go version description: Describes the procedure how to patch the Go version in the Loki build image. Update vulnerable Go version to non-vulnerable Go version to build Grafana Loki binaries. Determine the . Need to sign-in to Docker hub to be able to push Loki build image. Find Go version to which you need to update. Example `1.20.5` to `1.20.6` Update Go version in the Grafana Loki build image (`loki-build-image/Dockerfile`) on the `main` branch. the Dockerfile change to `release-VERSION_PREFIX` branch. the Loki Build Image version change from `main` to `release-VERSION_PREFIX` branch.
Project: Checkmk (Observability and Analysis / Observability)
File: 16357.md

key | value | date | 2024-04-18T11:02:41+00:00 version | 2.4.0b1 class | fix edition | cre component | checks level | 1 compatible | yes The active certificate check (configured via the ruleset Check certificates) did not check the common name (CN) of the certificate issuer correctly: If only the checking of the issuer CN was activated, the CN of the subject was checked instead. If both the checking of the issuer and the subject CN where activated, the active check crashed with\ <code>error: the argument '--subject-cn \<SUBJECT_CN\>' cannot be used multiple times.</code>
Project: Checkmk (Observability and Analysis / Observability)
File: 16175.md

key | value | compatible | yes version | 2.4.0b1 date | 2024-03-08T10:39:25+00:00 level | 1 class | feature component | checks edition | cre apcnetbotzsensors and apcnetbotzother_sensors checks provided monitoring for APC Netbotz v2 devices. Now, the checks can additionally monitor APC Netbotz 50 devices.
Project: Netdata (Observability and Analysis / Observability)
File: troubleshooting.md

[% if entry.integration_type == 'collector' %] [% if entry.meta.plugin_name is in(['go.d.plugin', 'python.d.plugin', 'charts.d.plugin']) %] To troubleshoot issues with the `[[ entry.meta.modulename ]]` collector, run the `[[ entry.meta.pluginname ]]` with the debug option enabled. The output should give you clues as to why the collector isn't working. Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` [% if entry.meta.plugin_name == 'go.d.plugin' %] Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m [[ entry.meta.module_name ]] ``` [% elif entry.meta.plugin_name == 'python.d.plugin' %] Run the `python.d.plugin` to debug the collector: ```bash ./python.d.plugin [[ entry.meta.module_name ]] debug trace ``` [% elif entry.meta.plugin_name == 'charts.d.plugin' %] Run the `charts.d.plugin` to debug the collector: ```bash ./charts.d.plugin debug 1 [[ entry.meta.module_name ]] ``` [% endif %] [% else %] [% if entry.troubleshooting.problems.list %] [% endif %] [% endif %] [% elif entry.integration_type == 'notification' %] [% if 'cloud-notifications' in entry.srcpath|string %] [% if entry.troubleshooting.problems.list %] [% endif %] [% else %] You can run the following command by hand, to test alerts configuration: ```bash sudo su -s /bin/bash netdata export NETDATAALARMNOTIFY_DEBUG=1 /usr/libexec/netdata/plugins.d/alarm-notify.sh test /usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE" ``` Note that this will test all alert mechanisms for the selected role. [% endif %] [% elif entry.integration_type == 'exporter' %] [% if entry.troubleshooting.problems.list %] [% endif %] [% endif %] [% for item in entry.troubleshooting.problems.list %] [[ description ]] [% endfor %]
Project: Grafana Tempo (Observability and Analysis / Observability)
File: compression.md

title: Compression and encoding description: Learn about compression and encoding options available for Tempo. weight: 200 <!-- Page needs to be updated. --> Tempo can compress traces that it pushes to backend storage. This requires extra memory and CPU, but it reduces the quantity of stored data. Anecdotal tests suggest that `zstd` will cut your storage costs to ~15% of the uncompressed amount. It is highly recommended to use the default `zstd`. (The compression field is used for the old v2 format. the vParquet* formats compress columns individually.) Compression is configured under storage like so: ```yaml storage: trace: block: v2_encoding: zstd ``` The following options are supported: none gzip lz4-64k lz4-256k lz4-1M lz4 snappy zstd s2 Although all of these compression formats are supported in Tempo, at Grafana we use `zstd`. It's possible/probable that the other compression algorithms may have issue at scale. File an issue if you have any problems. The WAL also supports compression. By default, this is configured to use `snappy`. This comes with a small performance penalty but reduces disk I/O and and adds checksums to the WAL. All of the above configuration options are supported but only `snappy` has been tested at scale. ``` storage: trace: wal: v2_encoding: snappy ```
Project: Logging Operator (Kube Logging) (Observability and Analysis / Observability)
File: eventtailer_types.md

title: EventTailer weight: 200 generated_file: true EventTailerSpec defines the desired state of EventTailer Override container fields for the given statefulset The resources of EventTailer will be placed into this namespace Override image related fields for the given statefulset, highest precedence Volume definition for tracking fluentbit file positions (optional) Override podSpec fields for the given statefulset Override metadata of the created resources EventTailerStatus defines the observed state of EventTailer EventTailer is the Schema for the eventtailers API EventTailerList contains a list of EventTailer
Project: Litmus (Observability and Analysis / Chaos Engineering)
File: bug_report.md

name: "\U0001F41B Bug report" about: Create a report to help improve the project title: '' labels: bug assignees: '' <!-- Thanks for filing an issue! Before hitting the button, please answer these questions. Fill in as much of the template below as you can. If you leave out information, we can't help you as well. Be ready for followup questions, and please respond in a timely manner. If we can't reproduce a bug we might close your issue. If we're wrong, PLEASE feel free to reopen it and explain why. --> What happened: What you expected to happen: Where can this issue be corrected? (optional) <!-- provide additional information about the file location or directory that needs to be modified to fix this issue, if available --> How to reproduce it (as minimally and precisely as possible): Anything else we need to know?:
Project: Grafana (Observability and Analysis / Observability)
File: release-notes-8-3-0.md

_build: list: false labels: products: cloud enterprise oss title: Release notes for Grafana 8.3.0 <!-- Auto generated by update changelog github action --> Alerting: Prevent folders from being deleted when they contain alerts. , Alerting: Show full preview value in tooltip. , BarGauge: Limit title width when name is really long. , CloudMonitoring: Avoid to escape regexps in filters. , CloudWatch: Add support for AWS Metric Insights. , TooltipPlugin: Remove other panels' shared tooltip in edit panel. , Visualizations: Limit y label width to 40% of visualization width. , Alerting: Clear alerting rule evaluation errors after intermittent failures. , Alerting: Fix refresh on legacy Alert List panel. , Dashboard: Fix queries for panels with non-integer widths. , Explore: Fix url update inconsistency. , Prometheus: Fix range variables interpolation for time ranges smaller than 1 second. , ValueMappings: Fixes issue with regex value mapping that only sets color. ,
Project: Graylog (Observability and Analysis / Observability)
File: Navbar.md

```js import {Nav, NavItem, NavDropdown, MenuItem} from 'components/bootstrap'; <Navbar> <Nav activeKey={1}> <NavItem eventKey={1} href="/home"> NavItem 1 content </NavItem> <NavItem eventKey={2} title="Item"> NavItem 2 content </NavItem> <NavItem eventKey={3} disabled> NavItem 3 disabled </NavItem> <NavDropdown eventKey="4" title="Dropdown" id="nav-dropdown"> <MenuItem eventKey="4.1">Action</MenuItem> <MenuItem eventKey="4.2">Another action</MenuItem> <MenuItem eventKey="4.3">Something else here</MenuItem> <MenuItem divider /> <MenuItem eventKey="4.4">Separated link</MenuItem> </NavDropdown> </Nav> </Navbar> ``` ```js import {Nav, NavItem, NavDropdown, MenuItem} from 'components/bootstrap'; <Navbar inverse> <Nav activeKey={1}> <NavItem eventKey={1} href="/home"> NavItem 1 content </NavItem> <NavItem eventKey={2} title="Item"> NavItem 2 content </NavItem> <NavItem eventKey={3} disabled> NavItem 3 disabled </NavItem> <NavDropdown eventKey="4" title="Dropdown" id="nav-dropdown"> <MenuItem eventKey="4.1">Action</MenuItem> <MenuItem eventKey="4.2">Another action</MenuItem> <MenuItem eventKey="4.3">Something else here</MenuItem> <MenuItem divider /> <MenuItem eventKey="4.4">Separated link</MenuItem> </NavDropdown> </Nav> </Navbar> ```
Project: HertzBeat (Observability and Analysis / Observability)
File: udp_port.md

id: udp_port title: Monitoring UDP port availability sidebar_label: UDP Port availability keywords: [open source monitoring tool, open source port monitoring tool, monitoring UDP port metrics] UDP is a connectionless transport layer protocol. We determine the availability status of its ports by sending request packets at the application layer and receiving responses. The configuration information requires filling in the hexadecimal content of the application layer packets that prompt responses from the peer. We recommend using Wireshark for packet capture to obtain the transmitted packet content. You can click on `Create UDP Port Availability` to configure or select `More Actions` to import existing configurations. | Parameter name | Parameter help description | ||--| | Monitoring Host | Monitored IPV4, IPV6 or domain name. Note Without protocol header (eg: https://, http://). | | Monitoring name | Identify the name of this monitoring. The name needs to be unique. | | Port | Ports provided by website. | | Connection timeout | The waiting timeout for port connections, in milliseconds. Default is 6000 milliseconds. | | Sent Packet Content | The hexadecimal content of the application layer packet that prompts a response from the peer. | | Collector | Specifies which collector to use for scheduling collection for this monitoring. | | Collection interval | Interval time of monitor periodic data collection, unit: second, and the minimum interval that can be set is 30 seconds. | | Bind Tags | Classification management tags for monitoring resources. | | Description | For more information about identifying and describing this monitoring, users can note information here. | | Metric name | Metric unit | Metric help description | ||-|-| | Response Time | Milliseconds (ms) | Website response time |
Project: Headlamp (Observability and Analysis / Observability)
File: plugin_registry.PluginsLoadedEvent.md

title: "Interface: PluginsLoadedEvent" linkTitle: "PluginsLoadedEvent" slug: "plugin_registry.PluginsLoadedEvent" .PluginsLoadedEvent Event fired when all plugins are loaded. data: `Object` | Name | Type | Description | | : | : | : | | `plugins` | { `isEnabled`: `boolean` ; `name`: `string` ; `version`: `string` }[] | The list of loaded plugins. | _ type: `PLUGINS_LOADED`
Project: Headlamp (Observability and Analysis / Observability)
File: lib_k8s_apiProxy.ClusterRequestParams.md

title: "Interface: ClusterRequestParams" linkTitle: "ClusterRequestParams" slug: "libk8sapiProxy.ClusterRequestParams" .ClusterRequestParams The options for `clusterRequest`. `ClusterRequestParams` `Optional` autoLogoutOnAuthError: `boolean` Whether to automatically log out the user if there is an authentication error. . _ `Optional` cluster: ``null`` \| `string` Cluster context name. . _ `Optional` isJSON: `boolean` Is the request expected to receive JSON data? . _ `Optional` timeout: `number` Number of milliseconds to wait for a response. .
Project: Netdata (Observability and Analysis / Observability)
File: adaptec_raid_pd_state.md

A RAID controller is a card or chip located between the operating system and a storage drive (usually a hard drive). This is an alert about the Adaptec raid controller. The Netdata Agent checks the physical device statuses which are managed by your raid controller. This alert is triggered in critical state when the physical device is offline. Check the Offline Disk Use the `arcconf` CLI tool to identify which drive or drives are offline: ``` root@netdata # arcconf GETCONFIG 1 AL ``` This command will display the configuration of all the managed Adaptec RAID controllers in your system. Check the "DEVICE #" and "DEVICE_DEFINITION" fields for details about the offline devices. Examine RAID Array Health Check the array health status to better understand the overall array's stability and functionality: ``` root@netdata # arcconf GETSTATUS 1 ``` This will provide an overview of your RAID controller's health status, including the operational mode, failure state, and rebuild progress (if applicable). Replace the Offline Disk Before replacing an offline disk, ensure that you have a current backup of your data. Follow these steps to replace the drive: Power off your system. Remove the offline drive. Insert the new drive. Power on your system. After the drive replacement, the Adaptec RAID card should automatically start rebuilding the faulty disk drive using the new disk. You can check the progress of the rebuild process with the `arcconf` command: ``` root@netdata # arcconf GETSTATUS 1 ``` Monitor Rebuild Progress It's essential to monitor the RAID array's rebuild process to ensure it completes successfully. Use the `arcconf` command to verify the rebuild status: ``` root@netdata # arcconf GETSTATUS 1 ``` This command will display the progress and status of the rebuild process. Keep an eye on it until it's completed. Verify RAID Array Health After the rebuild is complete, use the `arcconf` command again to verify the health status of the RAID array: ``` root@netdata # arcconf GETSTATUS 1 ``` Make sure that the RAID array's status is "Optimal" or "Ready" and that the replaced disk drive is now online.