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

title: "Python" menuTitle: "Python" description: "Instrumenting Python applications for continuous profiling." weight: 40 aliases: /docs/phlare/latest/configure-client/language-sdks/python The Python profiler, when integrated with Pyroscope, transforms the way you analyze and optimize Python applications. This combination provides unparalleled real-time insights into your Python codebase, allowing for precise identification of performance issues It's an essential tool for Python developers focused on enhancing code efficiency and application speed. {{< admonition type="note" >}} Refer to for a list of profile types supported by each language. {{< /admonition >}} To capture and analyze profiling data, you need either a hosted Pyroscope OSS server or a hosted (requires a free Grafana Cloud account). The Pyroscope server can be a local server for development or a remote server for production use. Install the `pyroscope-io` pip package: ```bash pip install pyroscope-io ``` Add the following code to your application. This code will initialize the Pyroscope profiler and start profiling: ```python import pyroscope pyroscope.configure( application_name = "my.python.app", # replace this with some name for your application server_address = "http://my-pyroscope-server:4040", # replace this with the address of your Pyroscope server ) ``` Optionally, you can configure several additional parameters: ```python import pyroscope pyroscope.configure( application_name = "my.python.app", # replace this with some name for your application server_address = "http://my-pyroscope-server:4040", # replace this with the address of your Pyroscope server sample_rate = 100, # default is 100 detect_subprocesses = False, # detect subprocesses started by the main process; default is False oncpu = True, # report cpu time only; default is True gil_only = True, # only include traces for threads that are holding on to the Global Interpreter Lock; default is True enable_logging = True, # does enable logging facility; default is False tags = { "region": '{os.getenv("REGION")}', } ) ``` You can add tags to certain parts of your code: ```python with pyroscope.tagwrapper({ "controller": "slowcontrolleriwanttoprofile" }): slow_code() ``` ```python import pyroscope pyroscope.configure( application_name = "example.python.app", server_address = "<URL>", basicauthusername = '<User>', basicauthpassword = '<Password>', ) ``` To configure the Python SDK to send data to Pyroscope, replace the `<URL>` placeholder with the appropriate server URL. This could be the Grafana Cloud URL or your own custom Pyroscope server URL. If you need to send data to Grafana Cloud, you'll have to configure HTTP Basic authentication. Replace `<User>` with your Grafana Cloud stack user and `<Password>` with your Grafana Cloud API key. If your Pyroscope server has multi-tenancy enabled, you'll need to configure a tenant ID. Replace `<TenantID>` with your Pyroscope tenant ID. Check out the following resources to learn more about Python profiling: showing Python example with tags
Project: SkyWalking (Observability and Analysis / Observability)
File: time-and-timezone.md

There are three main reasons no data can be shown by the UI: No traces have been sent to the collector. Traces have been sent, but the timezone of your containers is incorrect. Traces are in the collector, but you're not watching the correct timeframe in the UI. Be sure to check the logs of your agents to see if they are connected to the collector and traces are being sent. Be sure to check the time in your containers. Be sure to configure the timeframe shown by the UI.
Project: Cortex (Observability and Analysis / Observability)
File: limitations.md

title: "Limitations" linkTitle: "Limitations" weight: 998 slug: limitations The tenant ID (also called "user ID" or "org ID") is the unique identifier of a tenant within a Cortex cluster. The tenant ID is an opaque information to Cortex, which doesn't make any assumption on its format/content, but its naming has two limitations: Supported characters Length The following character sets are generally safe for use in the tenant ID: Alphanumeric characters `0-9` `a-z` `A-Z` Special characters Exclamation point (`!`) Hyphen (`-`) Underscore (`_`) Single Period (`.`), but the tenant IDs `.` and `..` is considered invalid Asterisk (`*`) Single quote (`'`) Open parenthesis (`(`) Close parenthesis (`)`) All other characters are not safe to use. In particular, slashes `/` and whitespaces (` `) are not supported. The tenant ID length should not exceed 150 bytes/characters. When running queries to the `/api/v1/series`, `/api/v1/labels` and `/api/v1/label/{name}/values` endpoints, query's time range is ignored and the data is always fetched from ingesters. There is experimental support to query the long-term store with the blocks storage engine when `-querier.query-store-for-labels-enabled` is set.
Project: Netdata (Observability and Analysis / Observability)
File: opsgenie.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/integrations/opsgenie.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/integrations/cloud-notifications/metadata.yaml" sidebar_label: "Opsgenie" learn_status: "Published" learnrelpath: "Alerts & Notifications/Notifications/Centralized Cloud Notifications" message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE NOTIFICATION'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/opsgenie.png" width="150"/> From the Netdata Cloud UI, you can manage your space's notification settings and enable the configuration to deliver notifications on Opsgenie. <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> A Netdata Cloud account Access to the Netdata Space as an Admin The Netdata Space needs to be on a paid plan You need to have permissions on Opsgenie to add new integrations. Steps to configure your Opsgenie to receive notifications from Netdata: Go to integrations tab of your team, click Add integration Pick API from available integrations. Copy your API Key and press Save Integration. Paste copied API key into the corresponding field in Integration configuration section of Opsgenie modal window in Netdata. Click on the Space settings cog (located above your profile icon) Click on the Notification tab Click on the + Add configuration button (near the top-right corner of your screen) On the Opsgenie card click on + Add A modal will be presented to you to enter the required details to enable the configuration: Notification settings* are Netdata specific settings Configuration name - you can optionally provide a name for your configuration you can easily refer to it Rooms - by specifying a list of Rooms you are select to which nodes or areas of your infrastructure you want to be notified using this configuration Notification - you specify which notifications you want to be notified using this configuration: All Alerts and unreachable, All Alerts, Critical only Integration configuration* are the specific notification integration required settings, which vary by notification method. For Opsgenie: API Key - a key provided on Opsgenie for the channel you want to receive your notifications.
Project: Vector (Observability and Analysis / Observability)
File: opentelemetry.md

title: OpenTelemetry description: Receive data through gRPC or HTTP. component_kind: source layout: component tags: ["opentelemetry", "component", "source", "logs"] {{/* This doc is generated using: The template in layouts/docs/component.html The relevant CUE data in cue/reference/components/... */}}
Project: Checkmk (Observability and Analysis / Observability)
File: 16173.md

key | value | date | 2024-02-28T08:58:09+00:00 version | 2.4.0b1 class | security edition | cre component | checks level | 1 compatible | yes Symantec Anti Virus plugin uses /opt/Symantec/symantec_antivirus/sav command to monitor a Symantec Anti Virus installation. To prevent privilege escalation, the plugin (which is run by root user) must not run executables which can be changed by less privileged users. In the default installation, sav command is owned by root and root is the only user with write permissions, which prevents privilege escalation attacks. With this Werk, the plugin checks if sav command is owned by root and root is the only user with write permissions before running the command. If that's not the case the command won't be run. This prevents privilege escalation attacks if the permissions of the sav command have been changed. We rate this with a CVSS of 0 (None) (CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:N). This CVSS is primarily meant to please automatic scanners. CMK-15318
Project: Logging Operator (Kube Logging) (Observability and Analysis / Observability)
File: logscale.md

title: LogScale weight: 200 generated_file: true The `LogScale` output sends log records over HTTP to Falcon's LogScale. Based on the . Sends log records over HTTP to Falcon's LogScale. {{< highlight yaml >}} apiVersion: logging.banzaicloud.io/v1beta1 kind: SyslogNGOutput metadata: name: test-logscale namespace: logging spec: logscale: token: valueFrom: secretKeyRef: key: token name: logscale-token timezone: "UTC" batch_lines: 1000 disk_buffer: diskbufsize: 512000000 dir: /buffers reliable: true {{</ highlight >}} A JSON object representing key-value pairs for the Event. These key-value pairs adds structure to Events, making it easier to search. Attributes can be nested JSON objects, however, we recommend limiting the amount of nesting. Default: `"--scope rfc5424 --exclude MESSAGE --exclude DATE --leave-initial-dot"` This field specifies the content type of the log records being sent to Falcon's LogScale. Default: `"application/json"` This option enables putting outgoing messages into the disk buffer of the destination to avoid message loss in case of a system failure on the destination side. For details, see the . Default: false This field represents additional headers that can be included in the HTTP request when sending log records to Falcon's LogScale. Default: empty The raw string representing the Event. The default display for an Event in LogScale is the rawstring. If you do not provide the rawstring field, then the response defaults to a JSON representation of the attributes field. Default: empty The timezone is only required if you specify the timestamp in milliseconds. The timezone specifies the local timezone for the event. Note that you must still specify the timestamp in UTC time. An is a unique string that identifies a repository and allows you to send data to that repository. Default: empty Ingester URL is the URL of the Humio cluster you want to send data to. Default: https://cloud.humio.com
Project: Inspektor Gadget (Observability and Analysis / Observability)
File: oomkill.md

title: Gadget oomkill oomkill monitors when OOM killer is triggered and kills a process. ```yaml apiVersion: gadget.kinvolk.io/v1alpha1 kind: Trace metadata: name: oomkill namespace: gadget spec: node: ubuntu-hirsute gadget: oomkill runMode: Manual outputMode: Stream filter: namespace: default ``` Start oomkill gadget ```bash $ kubectl annotate -n gadget trace/oomkill \ gadget.kinvolk.io/operation=start ``` Stop oomkill gadget ```bash $ kubectl annotate -n gadget trace/oomkill \ gadget.kinvolk.io/operation=stop ``` Stream
Project: Headlamp (Observability and Analysis / Observability)
File: mac-installation.md

title: Mac OS Installation linktitle: Mac OS weight: 20 Once you have the itself installed, you can install the latest Headlamp release by running the following command: ```sh brew install --cask headlamp ``` To upgrade Headlamp when it's installed via Homebrew, run: ```sh brew upgrade headlamp ``` For more information on upgrading packages with Homebrew, including automatic updates, please read the . For Mac OS we provide a .dmg file, so you need to download it from the and then follow the below steps : Double click the downloaded file to make its content available (name will show up in the Finder sidebar), usually a window opens showing the content as well Drag the application from the DMG window into /Applications to install wait for the copy process to finish. Once the installation process is completed you can find Headlamp as a desktop app in Applications directory. Until we have an automatic update, to upgrade Headlamp when it's installed directly via the releases page, you have to download any newer version and re-install it.
Project: Grafana (Observability and Analysis / Observability)
File: release-notes-8-3-6.md

hide_menu: true labels: products: cloud enterprise oss title: Release notes for Grafana 8.3.6 <!-- Auto generated by update changelog github action --> Cloud Monitoring: Reduce request size when listing labels. , Explore: Show scalar data result in a table instead of graph. , Snapshots: Updates the default external snapshot server URL. , Table: Makes footer not overlap table content. , Tempo: Add request histogram to service graph datalink. , Tempo: Add time range to tempo search query behind a feature flag. , Tempo: Auto-clear results when changing query type. , Tempo: Display start time in search results as relative time. , CloudMonitoring: Fix resource labels in query editor. , Cursor sync: Apply the settings without saving the dashboard. , LibraryPanels: Fix for Error while cleaning library panels. , Logs Panel: fix timestamp parsing for string dates without timezone. , Prometheus: Fix some of the alerting queries that use reduce/math operation. , TablePanel: Fix ad-hoc variables not working on default datasources. , Text Panel: Fix alignment of elements. , Variables: Fix for constant variables in self referencing links. ,
Project: Headlamp (Observability and Analysis / Observability)
File: lib_k8s_statefulSet.KubeStatefulSet.md

title: "Interface: KubeStatefulSet" linkTitle: "KubeStatefulSet" slug: "libk8sstatefulSet.KubeStatefulSet" .KubeStatefulSet `KubeStatefulSet` `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 | | : | : | | `selector` | | | `template` | { `metadata`: ; `spec`: } | | `template.metadata` | | | `template.spec` | | | `updateStrategy` | { `rollingUpdate`: { `partition`: `number` } ; `type`: `string` } | | `updateStrategy.rollingUpdate` | { `partition`: `number` } | | `updateStrategy.rollingUpdate.partition` | `number` | | `updateStrategy.type` | `string` | _ status: `Object`
Project: Netdata (Observability and Analysis / Observability)
File: zfs_pool_state_warn.md

This alert is triggered when the state of a ZFS pool changes to a warning state, indicating potential issues with the pool, such as disk errors, corruption, or degraded performance. Check pool status: Use the `zpool status` command to check the status of the ZFS pool and identify any issues or errors. Review disk health: Inspect the health of the disks in the ZFS pool using `smartctl` or other disk health monitoring tools. Replace faulty disks: If a disk in the ZFS pool is faulty, replace it with a new one and perform a resilvering operation using `zpool replace`. Scrub the pool: Run a manual scrub operation on the ZFS pool with `zpool scrub` to verify data integrity and repair any detected issues. Monitor pool health: Keep an eye on the ZFS pool's health and performance metrics to ensure that issues are resolved and do not recur.
Project: Coroot (Observability and Analysis / Observability)
File: CONTRIBUTING.md

Thank you for your interest in contributing to Coroot! Below are some basic guidelines. Go v1.21 Node v21 Run frontend builder (watcher): ```shell cd front npm ci npm run build-dev ``` Run backend: ```shell go mod tidy go run main.go ``` Open http://127.0.0.1:8080 in your browser. Branch from the main branch and, if needed, rebase to the current main branch before submitting your pull request. If it doesn't merge cleanly with main you may be asked to rebase your changes. Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests). Add tests relevant to the fixed bug or new feature. Use `make lint` to run linters and ensure formatting is correct. Run the unit tests suite `make test`. Enable the following "Actions on Save" for automatic formatting: TODO...
Project: Vector (Observability and Analysis / Observability)
File: influxdb_metrics.md

title: InfluxDB metrics description: Deliver metric event data to component_kind: sink layout: component tags: ["influxdb", "influx", "component", "sink", "metrics"] {{/* This doc is generated using: The template in layouts/docs/component.html The relevant CUE data in cue/reference/components/... */}}
Project: Checkmk (Observability and Analysis / Observability)
File: 16240.md

key | value | compatible | yes version | 2.4.0b1 date | 2024-02-28T14:12:59+00:00 level | 1 class | fix component | checks edition | cre You're affected if you want to monitor your CPU and the cpu check crashes with something like: ``` File "/omd/sites/YOURSITE/lib/python3/cmk/base/plugins/agentbased/cpu.py", line 48, in parsecpu count=int(row[3].split("/")[1]), ValueError (invalid literal for int() with base 10: '') ``` We saw this happening on AIX system when the ps information cannot be obtained due to low memory. The parsing is now more resilient against such missing data.
Project: Kepler (Observability and Analysis / Observability)
File: GOVERNANCE.md

Qualified new maintainers are approved via consensus by the group of existing maintainers. Technical committee provides technical oversight for the overall architectural design and project development. Responsibilities include: Oversee the overall direction of the Kepler project Provide guidance for the project maintainers and the onboarding process for new maintainers Actively engage in the technical committee meetings The current list of technical committee members is published and updated in . Proficient in one or more of the following areas: Developing and maintaining Kepler core Developing and maintaining Kepler deployment and integration (including Operator) Developing and maintaining Kepler model server and models Developing and maintaining test suites Developing and maintaining CI infra Maintaining documentation. Responsibilities include: Strong commitment to the project Participate in design and technical discussions Contribute non-trivial pull requests Actively attend the community meetings Perform code reviews on other's pull requests Regularly triage GitHub issues. Make sure that ongoing PRs are moving forward at the right pace or closing them Monitor Kepler Slack (delayed response is perfectly acceptable), particularly for the area of your expertise Responsibilities include: Perform code reviews on other's pull requests Regularly triage GitHub issues. Make sure that ongoing PRs are moving forward at the right pace or closing them Monitor Kepler Slack (delayed response is perfectly acceptable), particularly for the area of your expertise Advisory committee provides guidance for the overall direction of the Kepler project, including but not limited to: Project roadmap Project governance Project releases Project marketing Members of the advisory committee are expected to be active in the Kepler community and attend the advisory committee meetings. Members are expected to serve for a term of one year, with the option to renew for additional terms. Members are invited and approved by the Kepler maintainers.
Project: Kubeinvaders (Observability and Analysis / Chaos Engineering)
File: LICENSE.md

The MIT License (MIT) Copyright (c) 2014-2022 Chart.js Contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Project: Netdata (Observability and Analysis / Observability)
File: vcsa_system_health.md

The `vcsasystemhealth` alert indicates the overall health status of your VMware vCenter Server Appliance (vCSA). If you receive this alert, it means that one or more components in the appliance are in a degraded or unhealthy state that could lead to reduced performance or even appliance unresponsiveness. Perform the following steps to identify and resolve the issue: Log in to the vCenter Server Appliance Management Interface (VAMI). You can access the VAMI by navigating to `https://<yourvcenteraddress>:5480` in a web browser. Log in with the appropriate credentials. Check the System Health status. In the VAMI, click on the `Monitor` tab, and then click on `Health`. This will provide you with an overview of the different components and their individual health status. Analyze the affected components. Identify the components that are displaying warning (yellow), degraded (orange), or critical (red) health status. These components may be causing the overall `vcsasystemhealth` alert. Investigate the problematic components. Click on each affected component to find more information about the issue. This may include error messages, suggested actions, and links to relevant documentation. Resolve the issues. Follow the recommended actions or consult the VMware documentation to resolve the issues with the affected components. Verify the system health. Once the issues have been resolved, refresh the Health page in the VAMI to ensure that all components now display a healthy (green) status. The `vcsasystemhealth` alert should clear automatically.
Project: Opstrace (Observability and Analysis / Observability)
File: 3-report-a-flaky-test.md

name: Report a flaky test about: Report an instability in our CI labels: ci-instability <!-- Thank you for reporting a flaky test. Flaky tests are tests that pass most of the time yet fail occasionally. If any investigation has been done, please include any information found, such as how consistently the test fails, whether the failure could be reproduced locally, when the test started failing, or anything else you think is relevant. --> Test Name*: Console Output:* ``` REPLACE ME ``` Build Links*:
Project: Checkmk (Observability and Analysis / Observability)
File: 16180.md

key | value | date | 2024-03-28T13:45:23+00:00 version | 2.4.0b1 class | feature edition | cre component | checks level | 1 compatible | yes This only affects plugin developers using the new API `cmk.rulesets.v1`. The datamodel for the `Proxy`, `Levels`, `TimePeriod` and `Password` Formspecs is changed. Use the `migrateto...` migration function to update your stored configurations to the newer datamodel.