Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/content/docs/docs/kloudmate-agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Opt in per service or database:

- **Application performance monitoring (APM):** distributed traces for Java, Node.js, Python, .NET, and PHP applications.
- **Database monitoring:** health metrics, query performance, and logs for your databases.
- **Process monitoring:** CPU and memory usage for the processes that matter most on a host. See [Process monitoring](process-monitoring/).

The agent also reports its own status and error logs.

Expand Down
29 changes: 14 additions & 15 deletions src/content/docs/docs/kloudmate-agent/management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,48 +9,47 @@ The KloudMate Agent is managed centrally from the web UI, so there is no need to

## Agents Overview

The KloudMate agent's landing page lets you view, add, and manage agents. After an agent is integrated, you can view its details:
The KloudMate agent's landing page lets you view, add, and manage agents. After an agent is integrated, it appears in the table:

![image](./images/managing-kloudmate-agents-3.png)

- **Hostname:** The agent's host machine name.
- **Platform:** The operating system or environment of the agent.
- **Status:** Current running status of the agent.
- **Host:** The agent's host machine name, with its platform and architecture underneath (for example, `Linux · amd64`).
- **Status:** The agent's current reachability, such as **Healthy** or **Unreachable**, plus a **Restart pending** tag while a restart is in progress.
- **Mode:** Whether the agent is in **Managed** or **Manual** configuration mode. See [Managed and manual mode](#managed-and-manual-mode).
- **Agent Version:** Version of the KloudMate agent used during integration.
- **Updated At:** The last time the collector configuration was updated.
- **Last Seen:** How long ago the agent last checked in.

## Adding a New Agent

1. Click the **Add Agent** button located at the top-right corner of the page.

![image](./images/managing-kloudmate-agents-1.png)

2. Select an agent from the available integrations list.
2. Choose where you want to install the agent.

![image](./images/managing-kloudmate-agents-2.png)

:::note
After selecting an agent, refer to the corresponding installation guide:
After choosing a platform, refer to the corresponding installation guide:

[Linux](../installation/linux-agent/) | [Docker](../installation/docker-agent/) | [Windows](../installation/windows-agent/) | [Kubernetes](../installation/kubernetes-agent/)
[Linux](../installation/linux-agent/) | [Docker](../installation/docker-agent/) | [Windows](../installation/windows-agent/) | [Kubernetes](../installation/kubernetes-agent/) | [Amazon ECS](../installation/ecs-agent/)
:::

## Remote Configuration Editor
## Configuring an Agent

The agent watches for remote configuration changes over a secure connection and updates itself automatically.
The agent watches for remote configuration changes over a secure connection and updates itself automatically.

:::danger
**Do not hand-edit local files in managed mode.**
In managed mode, KloudMate regenerates the collector configuration from your toggles, so manual edits to ConfigMaps or local configuration files will be overwritten. Always use the **KloudMate Agent Config Editor** in the web UI.
In managed mode, KloudMate regenerates the collector configuration from your toggles, so manual edits to ConfigMaps or local configuration files will be overwritten. Always use the **Configure** action in the web UI.
:::

From the KloudMate platform, you can update the collector configuration for any agent:
Open the actions menu (⋮) for an agent to manage it:

![image](./images/managing-kloudmate-agents-4.png)

- **Collector Configuration:** Open the web-based YAML editor to change the collector settings. Updates apply automatically wherever the agent is installed.
- **APM Configuration:** Configure the applications running on your Kubernetes cluster (applicable only for Kubernetes agents).
- **Restart Collector:** Restart the collector service when needed.
- **Configure:** Opens the agent's Configuration page, with tabs for **APM**, **Databases**, **Logs**, **Processes**, and **Collector config**. Updates apply automatically wherever the agent is installed.
- **Restart agent:** Restart the agent when needed.
- **Delete:** Remove the agent from the KloudMate Agent landing page and clear all of its configuration.

:::caution
Expand Down
25 changes: 25 additions & 0 deletions src/content/docs/docs/kloudmate-agent/process-monitoring.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Process Monitoring"
description: "Monitor the processes that matter most on each host — enable it from Settings and view them in a new Processes tab."
sidebar:
order: 8.5
---

Monitor the processes that matter most on each host — enable it from **Settings** and view them in a new **Processes** tab.

## What it collects

Process monitoring tracks CPU and memory usage for well-known processes on a host, plus any additional processes you add. It is off by default.

## Turn it on

1. Open **Settings → Agents** and select a host.
2. Go to the **Processes** tab.
3. Turn on **Enable process monitoring**.
4. Click **Apply**.

![image](./images/process-monitoring-1.png)

- **Monitor top processes:** The number of heaviest processes to track, on top of the well-known set.
- **Additional processes to track:** Comma-separated process names to always track. `*` works as a wildcard, for example `backup-*, ffmpeg`.
- **Ignored processes:** Comma-separated process names to never track, for example `chrome, java`.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion src/content/docs/docs/platform/settings/data-sources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ From this page, you can:
- Open account details and edit the connection
- Review or update sync settings
- Access CloudWatch log subscription controls
- Remove an AWS account
- [Remove an AWS account](../deleting-your-aws-account-from-kloudmate/)

![Connected AWS accounts on the Data Sources page](./images/data-sources-1.png)

Expand Down Expand Up @@ -98,5 +98,6 @@ Reach for it after you re-enable a region or fix a permission problem and want t
## Related Resources

- [AWS Account Setup](../../../aws-integration/account-setup/)
- [Remove an AWS Account](../deleting-your-aws-account-from-kloudmate/)
- [Troubleshoot AWS sync](../troubleshoot-aws-sync/)
- [CloudWatch Logs](../../../aws-integration/cloudwatch-logs/)
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,14 @@ sidebar:

Use this workflow when you want to disconnect an AWS account from KloudMate and clean up the integration resources in AWS.

Only users with **Owner** permissions can remove connected AWS accounts.
- Only users with **Owner** permissions can remove connected AWS accounts.
- AWS accounts can always be removed cleanly, even after permissions change on the AWS side.

## Remove the AWS Account from KloudMate

1. Open **Settings -> Data Sources**.

![image](./images/deleting-your-aws-account-from-kloudmate-1.png)

2. Select the connected AWS account you want to remove.
3. Open the account details screen.
4. Click **Delete Account**.

![image](./images/data-sources-3.png)
1. Open **Settings → Data Sources** and select the connected AWS account you want to remove. See [Manage connected accounts](../data-sources/#manage-connected-accounts) if you need help finding it.
2. Click **Edit** to open the account details screen.
3. Click **Delete Account**.

![image](./images/data-sources-4.png)

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions src/content/docs/docs/rum/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Those two numbers often differ sharply. A page that loads in 400 ms on your lapt

RUM data is worth little until something collects, stores, and queries it. An SDK in your application sends its measurements to KloudMate, and the [RUM interface](./rum-interface/) turns them into pages you can read, filter, and share. Because that data sits alongside your logs, metrics, and backend traces, you can go from a slow request in a browser session to the backend service that made it slow.

![image](./images/rum-kloudmate-overview.png)

### How does RUM work?

You add a small SDK to your website or mobile app. From then on it watches page loads, route changes, network calls, clicks, and errors as they happen, and sends what it records to KloudMate. Your application code doesn't change beyond the one call that initializes the SDK.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ The toolbar at the top provides the following controls:

KloudMate integrates alerts directly into your dashboard visualizations, providing immediate context on system health alongside your metrics.

![image](./images/dashboard-details-5.png)

- **Linked Alerts:** Click the bell icon in the toolbar to open the Linked Alerts drawer, which lists every alert linked to a panel in the dashboard.
- **Panel Alert Indicators:** If a panel is linked to an alert and the alert is currently **Firing**, a status indicator will appear on the panel header.
- **Alerts Drawer:** Clicking on an alert indicator opens the Alerts Drawer without leaving the dashboard context. This drawer displays information for alerts in the **Firing** state:
- The current evaluation state of the alert.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ To make any changes to a dashboard, including editing panels, updating settings,

Click **Exit edit** to return to view mode without saving, or **Save** to save your changes.

## Adding Sections to a Dashboard

Sections group related panels under a collapsible header, so long dashboards stay easy to scan. In edit mode, click **Add**, then select **Add section**.

![image](./images/managing-dashboards-3.png)

Click the section header to expand or collapse the panels underneath it, and drag panels into it to organize them.

## Dashboard Settings

Click the **Settings** icon in the toolbar while in edit mode to open the Dashboard Settings panel. From here you can:
Expand Down Expand Up @@ -48,3 +56,19 @@ You can add and manage variables in your dashboards. Variables are placeholders
4. Click **Save**.

Once the variable has been added, you can use it by selecting the created variable in the panel query box and saving the new query.

### Variable values from attribute values, filtered by metric

Populating a variable from OTel attribute values adds these fields:

- **OTel Dataset:** Choose the dataset (e.g., Metrics) to pull attribute values from.
- **OTel Attribute Key:** Choose the attribute whose values populate the variable, such as `host_name`.
- **Metric (optional):** Reads the attribute off this metric's series, so a label can come from a metric that carries it even when the panels chart a different one. Leave empty to look across every metric. The dropdown lists any existing template variables alongside the available metrics with their type (Gauge, Sum, and so on).
- **Filters:** Click **Add filter** to narrow the values further by other attributes.
- **Regex (optional):** Enter a regular expression, such as `/^prod-(.*)/`, to match only values that fit the pattern.

![image](./images/managing-dashboards-4.png)

Turn on **Multi Values** to let viewers select more than one value at once, and **Show All option** to add an **All** choice to the variable dropdown.

The **Preview of values** list updates as you adjust these fields, showing exactly what viewers will see in the variable dropdown.