diff --git a/docs/Admin-and-data/Account/Cloud/profile.md b/docs/Admin-and-data/Account/Cloud/profile.md index 841e1e3..93fe04b 100644 --- a/docs/Admin-and-data/Account/Cloud/profile.md +++ b/docs/Admin-and-data/Account/Cloud/profile.md @@ -1,36 +1,37 @@ -# Profile +# User Profile -This section lets you manage your personal profile settings, including your profile details, email addresses, and connected accounts. - - -## Accessing profile settings - -![!Screenshot](../../Account/Cloud/access-profile.png) - -!!! tip - You can also quickly access your profile by clicking your name and avatar at the bottom left corner of the screen on the Account page. +The **User Profile** page lets you manage your personal account settings and preferences, including your display name, email addresses, and connected accounts. ## Profile details -In **Profile details**, you’ll see your profile photo (or initials if no image is uploaded) along with your display name. You’ll also find a list of the email addresses linked to your account. +The **Profile details** section shows your current profile photo (or initials if no image has been uploaded) and your display name. +### Updating your profile -### Updating your Profile Settings +Click **Update profile** to open the edit panel where you can: -You can update your profile settings by clicking **Update profile** in the Profile section. This brings up a panel where you can change your profile photo, first name, and last name. To update your image, click the **Upload** button—make sure your file is a square (1:1 aspect ratio) and no larger than 10MB. - -Below the image, you’ll find fields for your first and last name. Make any changes as needed, then click **Save** to apply them. If you change your mind, you can click **Cancel** to exit without saving. +- Upload a new profile photo (must be square, 1:1 aspect ratio, max 10 MB) +- Update your first and last name +Click **Save** to apply changes, or **Cancel** to exit without saving. ![!Screenshot](../../Account/Cloud/update.png) -### Updating your email address +## Email addresses + +This section lists all email addresses linked to your account, with your primary address clearly labelled. -To add another email address to your account, click the **+ Add email address** button. A field will appear where you can type in the new email you'd like to associate with your profile. +### Adding an email address -After entering the address, click **Add**. You’ll be asked to verify the new email before it’s officially added to your account. This ensures that the email belongs to you and can be used for login, notifications, or as a backup. If you change your mind, just click **Cancel** to exit without adding it. +Click **+ Add email address**, enter the new address, then click **Add**. You will receive a verification email before the address is officially added to your account. ![!Screenshot](../../Account/Cloud/add-email.png) +## Connected accounts + +The **Connected accounts** section shows any third-party accounts linked to your profile (e.g. Google). These can be used for single sign-on (SSO) when logging in to OpsPilot. +--- +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Admin-and-data/Account/Cloud/security.md b/docs/Admin-and-data/Account/Cloud/security.md index dbb6c4f..7dd50d5 100644 --- a/docs/Admin-and-data/Account/Cloud/security.md +++ b/docs/Admin-and-data/Account/Cloud/security.md @@ -1,45 +1,47 @@ -# Security +# User Security -This dedicated Security page serves as your central hub for managing and enhancing the protection of your account. Here, you can actively control various aspects of your digital safety, including setting and updating your password, configuring secure passkeys for streamlined and robust authentication, and enabling two-step verification for an added layer of defense against unauthorized access. Additionally, you'll find a clear overview of your active devices, allowing you to monitor where your account is currently logged in. This comprehensive section empowers you to maintain strong control over your account's integrity and privacy. +The **User Security** page lets you manage the security settings for your account, including your password, passkeys, and two-step verification. ![!Screenshot](../../Account/Cloud/Security.png) ## Password -This section allows you to change your account password. +To set a new password: -### Changing your Password +1. Enter your new password in the **New password** field. +2. Re-enter it in the **Confirm password** field. +3. Check **Sign out of all other devices** to revoke access from any other active sessions. +4. Click **Save** to apply, or **Cancel** to discard. -To set a new password, you will find two fields: **New password** and **Confirm password**. Enter your desired new password into the "New password" field, and then re-enter the exact same password into the "Confirm password" field to ensure accuracy. +## Passkeys -Below these fields, you'll see an option to **Sign out of all other devices**. It is highly recommended to check this box. Doing so will automatically sign out any other devices that may still be logged in with your old password, enhancing your account's security. +Passkeys provide a more convenient and secure way to sign in without a password. -Once you have entered and confirmed your new password and made your selection for signing out of other devices, click **Save** to apply the changes. If you decide not to change your password or wish to discard your entries, simply click **Cancel** to return to the previous page without saving. +### Adding a passkey -## Passkeys +Click **+ Add a passkey**. You will be prompted to choose where to save it: -Passkeys provide a more convenient and secure way to sign in. - - -### Adding a Passkey - -When you click **+ Add a passkey** from the Security page, a "Windows Security" pop-up window will appear, prompting you to "Choose where to save this passkey." This step allows you to select the method you prefer for storing your new passkey. +| Option | Description | +|---|---| +| **iPhone, iPad, or Android device** | Saves the passkey to your mobile device using Face ID, Touch ID, or screen lock | +| **Security key** | Saves the passkey to a physical FIDO-compliant hardware key (e.g. YubiKey) | ![!Screenshot](../../Account/Cloud/passkey.png) -You have the following options: -* **iPhone, iPad, or Android device:** Select this option if you wish to save your passkey to a mobile device. This typically involves using your phone's built-in security features (like Face ID, Touch ID, or screen lock) to authenticate and store the passkey securely. You might be prompted to scan a QR code or approve a notification on your mobile device. -* **Security key:** Choose this option if you have a physical security key (like a YubiKey or similar FIDO-compliant device) and want to use it to store your passkey. This method offers strong, hardware-based security. +Click **Next** to complete setup, or **Cancel** to abort. -Once you have selected your preferred method: +## Two-step verification -* Click **Next** to proceed with the passkey creation process based on your chosen storage option. You will then follow further instructions to complete the setup. -* Click **Cancel** to close the window and abort the passkey addition process without saving any new passkey. +Two-step verification adds a second layer of security to your login by requiring a time-sensitive code from an authenticator app (e.g. Google Authenticator, Microsoft Authenticator, or Authy). -## Two-step verification +### Setting up two-step verification -When you opt to add two-step verification, you'll be presented with the **+ two-step verification** prompt. This method enhances your account's security by requiring a second form of verification in addition to your password. To set this up, you'll need an authenticator app on your smartphone (such as Google Authenticator, Microsoft Authenticator, or Authy). +1. Click **+ Two-step verification**. +2. Scan the QR code displayed on screen using your authenticator app. +3. If you cannot scan the QR code, click **Can't scan QR code?** to enter the key manually. +4. Click **Continue** to complete setup, or **Cancel** to abort. -The page displays a unique QR code that you must scan using your chosen authenticator application. Scanning this QR code will securely link the app to your account, generating time-sensitive codes that you'll use for future logins. If you are unable to scan the QR code, click the **Can't scan QR code?** link for alternative setup instructions, typically involving a manual key entry. +--- -Once the QR code is scanned and the app is linked, click **Continue** to finalize the setup, or **Cancel** to abort the process. \ No newline at end of file +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Admin-and-data/Account/Cloud/users.md b/docs/Admin-and-data/Account/Cloud/users.md index 7ff96d9..c1cc9aa 100644 --- a/docs/Admin-and-data/Account/Cloud/users.md +++ b/docs/Admin-and-data/Account/Cloud/users.md @@ -1,107 +1,41 @@ -# Account & member management +# Organization Users -## Organizational settings +The **Organization Users** page lets you view and manage all members of your organization, assign roles, and invite new users. -### General - -This section covers the basic organization-level settings accessible under the **General** tab in FusionReactor Cloud. - -![!Screenshot](../../Account/Cloud/general.png) - - -#### Organization Profile - -The Organization Profile section lets you view and update your organization's name and logo, which are shown to all members across the interface. - -#### Leave organization - -The **Leave organization** option lets any member (except the last admin) remove themselves from the org, which immediately revokes access to all org data and requires a new admin invitation to rejoin. - -!!! note - If you're the last admin in the organization, you **cannot leave** — you must either promote another member to admin or delete the organization instead. - - - -#### Delete organization - -Only admins can delete the organization, which permanently removes all members, data, and settings — this action cannot be undone. - - -### Members - -The **Members** tab in FusionReactor Cloud allows you to manage all users associated with your organization. You can view member details, assign roles, invite new members, and control access. +## Viewing members ![!Screenshot](../../Account/Cloud/members.png) -#### Viewing members - -Each row in the Members list includes: - -* **Name & Email** – Display name and primary email address. -* **Joined** – Date the user was added to the organization. -* **Role** – The current permission level assigned to the member. -* **Actions** – (⋯) menu to remove a member. - -You can also: +Each row in the members list includes: -* Use the search bar to filter members by name or email. -* Navigate through multiple pages if your org has many users. +| Field | Description | +|---|---| +| **Name & Email** | Display name and primary email address | +| **Joined** | Date the user was added to the organization | +| **Role** | The current permission level assigned to the member | +| **Actions (...)** | Remove the member from the organization | +Use the search bar to filter members by name or email. -#### Inviting members +## Inviting members -Click the **Invite** button in the top-right to add new users: +Click **Invite** in the top right to add a new user: 1. Enter the email address of the invitee. 2. Assign a default role. +3. Click **Invite** to send the invitation. !!! info Users are notified by email when invited to an organization. +## Role management -#### Role management -Use the dropdown under Role to instantly change a member’s permission level. +Use the **Role** dropdown to instantly change a member's permission level. !!! info "Learn more" [Roles](/Admin-and-data/Account/Cloud/roles/) - -### API Keys - -The **API Keys** page allows you to manage access credentials used by services or agents to communicate with FusionReactor Cloud. - -#### Viewing & managing keys - -Each listed API key displays: - -- **Name** – A user-defined label. -- **Description** – A short explanation of the key’s purpose. -- **Status toggle** – Temporarily enable or disable a key. -- **Copy icon** – Instantly copies the key to your clipboard (if visible). -- **Actions menu (⋯)** – Click to: - - **Edit** – Change the key’s name or description. - - **Remove** – Permanently delete the key. - -!!! note - Deleting a key immediately revokes access for anything using it. - - - -#### Creating a new key - -Click **+ Generate** to create a key. You’ll enter: - -- **Name** (required) -- **Description** (optional) - -### Billing - -The Billing section provides access to your organization's subscription details, invoices, and payment methods. - -!!! info "Learn more" - [Billing](/Admin-and-data/Billing/Cloud/overview/) - - - - +--- +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Admin-and-data/EULA.md b/docs/Admin-and-data/EULA.md index 5aca25c..3627476 100644 --- a/docs/Admin-and-data/EULA.md +++ b/docs/Admin-and-data/EULA.md @@ -48,7 +48,7 @@ You shall not:
**Provided, however**, notwithstanding the foregoing, you are **strictly prohibited** from installing or using the Trial Version of the Software for any **commercial training purpose**. -You shall not use the Developer Version for any application deployment in a **live**, **stand-by production**, or **staging** environment — in each case including, without limitation, any environment accessed by application end-users, including but not limited to: +You shall not use the Developer Version for any application deployment in a **live**, **stand-by production**, or **staging** environment - in each case including, without limitation, any environment accessed by application end-users, including but not limited to: * servers, * workstations, diff --git a/docs/Admin-and-data/Images/invoices.png b/docs/Admin-and-data/Images/invoices.png new file mode 100644 index 0000000..b8949a9 Binary files /dev/null and b/docs/Admin-and-data/Images/invoices.png differ diff --git a/docs/Admin-and-data/api-keys.md b/docs/Admin-and-data/api-keys.md new file mode 100644 index 0000000..73eed30 --- /dev/null +++ b/docs/Admin-and-data/api-keys.md @@ -0,0 +1,33 @@ +# API Keys + +The **API Keys** page lets you manage access credentials used by services and agents to communicate with OpsPilot. + +## Viewing & managing keys + +Each listed API key displays: + +| Field | Description | +|---|---| +| **Name** | A user-defined label for the key | +| **Description** | A short explanation of the key's purpose | +| **Status toggle** | Temporarily enable or disable the key | +| **Copy icon** | Copies the key value to your clipboard | +| **Actions (...)** | Edit the key's name or description, or permanently remove it | + +!!! note + Deleting a key immediately revokes access for anything using it. + +## Creating a new key + +Click **+ Generate** to create a new API key: + +1. Enter a **Name** (required). +2. Enter a **Description** (optional). +3. Click **Generate** to create the key. + +Copy the key immediately after creation - it will not be shown again in full. + +--- + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Admin-and-data/invoices.md b/docs/Admin-and-data/invoices.md new file mode 100644 index 0000000..f419920 --- /dev/null +++ b/docs/Admin-and-data/invoices.md @@ -0,0 +1,21 @@ +# Invoices + +The **Invoices** page lets you view and manage your invoices and upcoming payments. + +![!Screenshot](Images/invoices.png) + +Each invoice displays the following information: + +| Field | Description | +|---|---| +| **Invoice ID** | A unique identifier for the invoice | +| **Status** | Payment status (e.g. paid, pending) | +| **Date** | The date the invoice was issued | +| **Amount** | The total amount charged | + +Click the download icon on the right of any invoice to download it as a PDF. + +--- + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Admin-and-data/organization-settings.md b/docs/Admin-and-data/organization-settings.md new file mode 100644 index 0000000..58859ac --- /dev/null +++ b/docs/Admin-and-data/organization-settings.md @@ -0,0 +1,25 @@ +# Organization Settings + +The **Organization Settings** page lets you manage your organization's profile and general configuration in OpsPilot. + +![!Screenshot](Account/Cloud/general.png) + +## Organization Profile + +The Organization Profile section lets you view and update your organization's name and logo, which are shown to all members across the interface. + +## Leave organization + +The **Leave organization** option lets any member (except the last admin) remove themselves from the organization. This immediately revokes access to all org data and requires a new admin invitation to rejoin. + +!!! note + If you are the last admin in the organization, you **cannot leave** - you must either promote another member to admin or delete the organization instead. + +## Delete organization + +Only admins can delete the organization. This permanently removes all members, data, and settings and cannot be undone. + +--- + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Admin-and-data/usage-and-details.md b/docs/Admin-and-data/usage-and-details.md new file mode 100644 index 0000000..7b3d1a0 --- /dev/null +++ b/docs/Admin-and-data/usage-and-details.md @@ -0,0 +1,37 @@ +# Usage & Details + +The **Usage & Details** page gives you a real-time view of your cloud subscription status and current ingest usage against your plan limits. + +## Cloud Subscription + +The subscription card shows the key details of your current plan: + +| Field | Description | +|---|---| +| **Plan** | Your current subscription tier (e.g. Trial, Starter, Pro AI, Advanced AI) | +| **Interval** | Whether your plan is billed monthly or annually | +| **Status** | Current subscription status (e.g. active, expired) | +| **Renews At** | The date your subscription next renews | +| **Bills At** | The date your next invoice will be generated | + +## Ingest usage + +The **Ingest** section shows your current consumption against your plan limits for the active billing period: + +| Signal | Description | +|---|---| +| **Logs** | Volume of log data ingested (bytes / GB) | +| **Traces** | Volume of trace data ingested (bytes / GB) | +| **Metrics** | Number of active metric series | +| **Agents** | FusionReactor agent hours consumed | +| **OpsPilot** | OpsPilot AI tokens consumed | + +A progress bar shows the percentage of your allowance used. If you exceed your plan limit, on-demand billing applies for the overage. + +!!! info "Learn more" + [Billing overview](/Admin-and-data/Billing/Cloud/overview/) for a full breakdown of plan limits and on-demand rates. + +--- + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Contribute/how-to-contribute.md b/docs/Contribute/how-to-contribute.md index 08ab6d1..68b1c02 100644 --- a/docs/Contribute/how-to-contribute.md +++ b/docs/Contribute/how-to-contribute.md @@ -42,7 +42,7 @@ Contributing to our documentation is simpler than you might think. While you don - Click the pencil icon to enter edit mode. - Make your desired changes to the content. -- Don't worry about perfect formatting or grammar — our team will help with that. +- Don't worry about perfect formatting or grammar - our team will help with that. **Step 3: Save your work** diff --git a/docs/Data-insights/Features/Alerting/Active-alerts.md b/docs/Data-insights/Features/Alerting/Active-alerts.md index 62228a3..3225308 100644 --- a/docs/Data-insights/Features/Alerting/Active-alerts.md +++ b/docs/Data-insights/Features/Alerting/Active-alerts.md @@ -43,7 +43,7 @@ You can create a silence directly from an active notification without navigating 1. Expand a notification group by clicking the **>** arrow on the left. 2. Click the **Silence** button on the alert instance row. -3. The silence form will be pre-filled with the alert's labels — adjust the duration as needed. +3. The silence form will be pre-filled with the alert's labels - adjust the duration as needed. 4. Click **Submit** to suppress notifications immediately. !!! info "Learn more" diff --git a/docs/Data-insights/Features/Alerting/Alert-Rules/Configure-rules.md b/docs/Data-insights/Features/Alerting/Alert-Rules/Configure-rules.md index f4cc9a3..0073436 100644 --- a/docs/Data-insights/Features/Alerting/Alert-Rules/Configure-rules.md +++ b/docs/Data-insights/Features/Alerting/Alert-Rules/Configure-rules.md @@ -35,9 +35,9 @@ Grafana-managed rules also offer additional flexibility, including: !!! info "Migrating from simple alerting?" If you previously used FusionReactor's Mimir-based alerting, there are three key differences to be aware of: - - **Folders** — Alert rules must now be placed in a folder. You will need to create one if you haven't already. - - **Evaluation groups** — Rules are assigned to a group that controls their evaluation interval. Each rule must belong to a group. - - **Labels for routing** — Alerts are routed to contact points via notification policies using label matchers. You must add the correct label to your rule for it to reach the right destination. See [Notification Policies](../Notifications.md) for the recommended approach. + - **Folders** - Alert rules must now be placed in a folder. You will need to create one if you haven't already. + - **Evaluation groups** - Rules are assigned to a group that controls their evaluation interval. Each rule must belong to a group. + - **Labels for routing** - Alerts are routed to contact points via notification policies using label matchers. You must add the correct label to your rule for it to reach the right destination. See [Notification Policies](../Notifications.md) for the recommended approach. !!! tip "Getting started" For quick-start tutorials on key alerting features, see [Getting started with Grafana Alerting tutorials](https://grafana.com/docs/grafana/latest/alerting/best-practices/tutorials/). @@ -50,7 +50,7 @@ Navigate to **Alerting** > **Alert rules** and click **+ New alert rule**. ### 1. Name the Alert Rule -Enter a descriptive and unique name in the **Name** field. This name appears in notifications, so make it meaningful (such as, `High CPU — Production Server`). +Enter a descriptive and unique name in the **Name** field. This name appears in notifications, so make it meaningful (such as, `High CPU - Production Server`). !!! note The rule name automatically becomes the `alertname` label on every alert instance the rule produces. This label can be used in notification policy matchers and in notification message templates (such as, `{{ $labels.alertname }}`). @@ -71,7 +71,7 @@ Enter a descriptive and unique name in the **Name** field. This name appears in Every alert rule must be assigned to a **folder** and an **evaluation group**. This is new compared to the previous alerting setup. * **Folder:** Select an existing folder or click **+ New folder** to create one. Folders keep your rules organised and control access permissions. -* **Evaluation group:** Select an existing group or create a new one. The group sets the **evaluation interval** — how often all rules in the group are checked (such as, `1m`). +* **Evaluation group:** Select an existing group or create a new one. The group sets the **evaluation interval** - how often all rules in the group are checked (such as, `1m`). * **Pending period:** Set how long the condition must be continuously met before the alert fires (such as, `5m`). This prevents notifications for temporary spikes. * **Keep firing for:** Optionally hold the alert in a firing state for a period after the condition resolves, to avoid noisy recovered/re-fired cycles for flapping metrics. @@ -99,12 +99,12 @@ Use the **Configure no data and error handling** section to define what state th | Scenario | Option | Behaviour | | --- | --- | --- | | **No Data** | No Data | Alert enters the **No Data** state. | -| **No Data** | Alerting | Treat as if the condition was met — alert fires. | -| **No Data** | Normal | Treat as healthy — no notification sent. | +| **No Data** | Alerting | Treat as if the condition was met - alert fires. | +| **No Data** | Normal | Treat as healthy - no notification sent. | | **No Data** | Keep last state | Hold the previous evaluation result until data returns. | | **Error** | Error | Alert enters the **Error** state. | -| **Error** | Alerting | Treat as if the condition was met — alert fires. | -| **Error** | Normal | Treat as healthy — no notification sent. | +| **Error** | Alerting | Treat as if the condition was met - alert fires. | +| **Error** | Normal | Treat as healthy - no notification sent. | | **Error** | Keep last state | Hold the previous evaluation result until the error clears. | !!! tip @@ -145,7 +145,7 @@ Click **Save rule and exit** to activate the alert rule. It will begin evaluatin ## Pausing evaluation -After saving, you can pause evaluation of a rule without deleting it. From the **Alert rules** list, click the **pause** icon on any rule. While paused, the rule stops evaluating and no new alert instances are created or updated. Existing firing instances are not resolved — they remain in their last state until evaluation resumes. +After saving, you can pause evaluation of a rule without deleting it. From the **Alert rules** list, click the **pause** icon on any rule. While paused, the rule stops evaluating and no new alert instances are created or updated. Existing firing instances are not resolved - they remain in their last state until evaluation resumes. This is useful for temporarily disabling a noisy rule without losing its configuration. diff --git a/docs/Data-insights/Features/Alerting/Alerts-overview.md b/docs/Data-insights/Features/Alerting/Alerts-overview.md index 0d184ad..0a55918 100644 --- a/docs/Data-insights/Features/Alerting/Alerts-overview.md +++ b/docs/Data-insights/Features/Alerting/Alerts-overview.md @@ -1,6 +1,6 @@ Alerting allows you to define granular alert rules across your entire application environment and manage notifications using powerful, flexible routing. Built to handle complex, distributed architectures, it integrates seamlessly with the FusionReactor Cloud stack to provide a scalable and proactive monitoring solution that ensures high availability across any environment. -FusionReactor's alerting system is built on Grafana's **Ruler** (for rule evaluation) and **Alertmanager** (for notification routing) — the industry-standard open-source alerting stack used across Prometheus-based environments. All core concepts described in the [Grafana Alerting documentation](https://grafana.com/docs/grafana/latest/alerting/) apply directly here. +FusionReactor's alerting system is built on Grafana's **Ruler** (for rule evaluation) and **Alertmanager** (for notification routing) - the industry-standard open-source alerting stack used across Prometheus-based environments. All core concepts described in the [Grafana Alerting documentation](https://grafana.com/docs/grafana/latest/alerting/) apply directly here. !!! info "Migrating from simple alerting?" The advanced alerting system is more powerful but requires a few additional setup steps compared to the previous Mimir-based alerting. The key differences are: @@ -42,7 +42,7 @@ Each individual alert instance (one per time series) will be in one of the follo ### Alert rule state -The overall state of an alert rule is determined by the **worst-case** state across all of its instances. If any instance is Firing, the rule is considered Firing — even if all other instances are Normal. +The overall state of an alert rule is determined by the **worst-case** state across all of its instances. If any instance is Firing, the rule is considered Firing - even if all other instances are Normal. ### Alert rule health diff --git a/docs/Data-insights/Features/Alerting/Contact-points.md b/docs/Data-insights/Features/Alerting/Contact-points.md index 97dc3aa..c2634cd 100644 --- a/docs/Data-insights/Features/Alerting/Contact-points.md +++ b/docs/Data-insights/Features/Alerting/Contact-points.md @@ -23,7 +23,7 @@ Grafana supports dozens of platforms, including **Slack, Microsoft Teams, Email, ## Configure Contact Points -Create one contact point per notification destination. Notification policies will route alerts to the correct contact point based on the `channel` label on your alert rules — see [Notification Policies](Notifications.md) for the recommended routing setup. +Create one contact point per notification destination. Notification policies will route alerts to the correct contact point based on the `channel` label on your alert rules - see [Notification Policies](Notifications.md) for the recommended routing setup. ### How to Add a Contact Point diff --git a/docs/Data-insights/Features/Alerting/FAQ.md b/docs/Data-insights/Features/Alerting/FAQ.md index 1f42f64..ae1dc46 100644 --- a/docs/Data-insights/Features/Alerting/FAQ.md +++ b/docs/Data-insights/Features/Alerting/FAQ.md @@ -45,9 +45,9 @@ See [Silences](Silences.md) and [Time Intervals](Mute-timings.md) for setup inst Yes. There are two ways: -1. **Single contact point with multiple integrations** — Add both a Slack integration and an email integration to the same contact point. Both will receive every notification sent to that contact point. +1. **Single contact point with multiple integrations** - Add both a Slack integration and an email integration to the same contact point. Both will receive every notification sent to that contact point. -2. **Multiple policies with Continue matching** — Create separate child policies for each destination and enable **Continue matching** on each one. An alert matching the first policy will continue to be evaluated against sibling policies. +2. **Multiple policies with Continue matching** - Create separate child policies for each destination and enable **Continue matching** on each one. An alert matching the first policy will continue to be evaluated against sibling policies. --- @@ -81,7 +81,7 @@ Setting it to `0s` means the alert fires immediately on the first evaluation whe - The query label selectors are too specific and match no active series. - The data source connection is temporarily unavailable. -Review the **No Data** handling option on the rule — **Keep last state** is usually the safest default. See [Troubleshooting](Troubleshooting.md#alert-is-in-no-data-state) for more detail. +Review the **No Data** handling option on the rule - **Keep last state** is usually the safest default. See [Troubleshooting](Troubleshooting.md#alert-is-in-no-data-state) for more detail. --- @@ -89,7 +89,7 @@ Review the **No Data** handling option on the rule — **Keep last state** is us Enable **Keep firing for** on the alert rule. This holds the alert in a firing state for a defined period after the condition resolves, preventing noisy recovered/re-fired cycles for metrics that fluctuate around the threshold. -Increasing the **Pending period** also helps — a longer pending period requires the condition to be stable before firing. +Increasing the **Pending period** also helps - a longer pending period requires the condition to be stable before firing. --- diff --git a/docs/Data-insights/Features/Alerting/Notifications.md b/docs/Data-insights/Features/Alerting/Notifications.md index 8690970..d674edb 100644 --- a/docs/Data-insights/Features/Alerting/Notifications.md +++ b/docs/Data-insights/Features/Alerting/Notifications.md @@ -9,13 +9,13 @@ Notification policies are the engine of your alerting system, providing a flexib ## Recommended routing setup -The simplest approach — and the one we recommend to get started — is to use a **`channel` label** on your alert rules and match it with a regex policy per destination. This keeps your policy tree flat and makes routing immediately visible on the alert rule itself. +The simplest approach - and the one we recommend to get started - is to use a **`channel` label** on your alert rules and match it with a regex policy per destination. This keeps your policy tree flat and makes routing immediately visible on the alert rule itself. -### Step 1 — Create a contact point per destination +### Step 1 - Create a contact point per destination Navigate to **Alerting** > **Contact Points** and create one contact point for each notification destination you need (such as, a Slack workspace, an email address, or a webhook endpoint). See [Contact Points](Contact-points.md) for setup instructions. -### Step 2 — Create a child policy per destination +### Step 2 - Create a child policy per destination Navigate to **Alerting** > **Notification policies** and add a child policy under the Default policy for each destination: @@ -35,7 +35,7 @@ The result is a flat set of policies, each routing a specific channel label to i | `channel =~ .*slack.*` | Slack contact point | | `channel =~ .*webhook.*` | Webhook contact point | -### Step 3 — Label your alert rules +### Step 3 - Label your alert rules When creating an [alert rule](Alert-Rules/Configure-rules.md), add a `channel` label with the value matching the destination you want (such as, `channel=slack`). The matching child policy routes it automatically. @@ -45,7 +45,7 @@ Any alert without a matching `channel` label falls through to the **Default poli Using a regex matcher (`=~`) rather than an exact match (`=`) gives you flexibility. A label value of `slack-critical` will still be matched by `.*slack.*`, so you can be more specific on your rules without having to update the policy. !!! info "Advanced routing" - For more complex setups — such as nested policy trees, multi-team routing, or routing by severity across multiple destinations simultaneously — see [Notification policies](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/create-notification-policy/) in the Grafana documentation. + For more complex setups - such as nested policy trees, multi-team routing, or routing by severity across multiple destinations simultaneously - see [Notification policies](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/create-notification-policy/) in the Grafana documentation. ## Configuring the Default policy diff --git a/docs/Data-insights/Features/Alerting/Templates.md b/docs/Data-insights/Features/Alerting/Templates.md index 87b6582..89d79ae 100644 --- a/docs/Data-insights/Features/Alerting/Templates.md +++ b/docs/Data-insights/Features/Alerting/Templates.md @@ -1,4 +1,4 @@ -Use templating to transform raw technical metrics—like heap usage or slow request counts—into human-readable alerts. By incorporating dynamic data, your team can diagnose issues directly from a Slack message or email without opening the dashboard first. +Use templating to transform raw technical metrics-like heap usage or slow request counts-into human-readable alerts. By incorporating dynamic data, your team can diagnose issues directly from a Slack message or email without opening the dashboard first. ## Alert Rule Annotations diff --git a/docs/Data-insights/Features/Alerting/Troubleshooting.md b/docs/Data-insights/Features/Alerting/Troubleshooting.md index ff90911..8725860 100644 --- a/docs/Data-insights/Features/Alerting/Troubleshooting.md +++ b/docs/Data-insights/Features/Alerting/Troubleshooting.md @@ -63,7 +63,7 @@ This page covers common issues when setting up and operating FusionReactor alert 1. Open the alert rule and confirm a `channel` label is present with the correct value (such as, `channel=slack`). 2. Navigate to **Alerting** > **Notification policies** and confirm a child policy exists with a matcher like `channel =~ .*slack.*`. -3. Verify the operator is `=~` (regex match) and the regex value is correct — `.*slack.*` will match any label value containing the word "slack". +3. Verify the operator is `=~` (regex match) and the regex value is correct - `.*slack.*` will match any label value containing the word "slack". !!! tip You can verify which policy an alert will match by using the **Test** option on the Default policy in **Notification policies**. Enter the label key/value pairs from your alert rule to simulate routing. @@ -85,7 +85,7 @@ This page covers common issues when setting up and operating FusionReactor alert 1. Run the query manually in **Explore** to confirm whether data is being returned. 2. Check the agent or data source connection. 3. Review the **No Data** handling setting on the rule: - - **Keep last state** is a safe default — the alert will not change state until data resumes. + - **Keep last state** is a safe default - the alert will not change state until data resumes. - **Alerting** causes the alert to fire when no data is received, which is appropriate for availability monitoring. - **Normal** suppresses the alert, which may hide genuine outages. @@ -99,10 +99,10 @@ This page covers common issues when setting up and operating FusionReactor alert **Fix:** -1. **Increase the Pending period** — A pending period of `5m` or `10m` requires the condition to be continuously true before firing, smoothing out brief spikes. -2. **Use "Keep firing for"** — This holds the alert in a firing state for a period after the condition resolves, preventing rapid recovered/re-fired cycles. -3. **Adjust the threshold** — If the metric hovers just at the threshold, add a buffer (such as, changing `> 80` to `> 85`). -4. **Increase the Repeat interval** on the [notification policy](Notifications.md) — This reduces re-notification frequency without changing how the rule evaluates. +1. **Increase the Pending period** - A pending period of `5m` or `10m` requires the condition to be continuously true before firing, smoothing out brief spikes. +2. **Use "Keep firing for"** - This holds the alert in a firing state for a period after the condition resolves, preventing rapid recovered/re-fired cycles. +3. **Adjust the threshold** - If the metric hovers just at the threshold, add a buffer (such as, changing `> 80` to `> 85`). +4. **Increase the Repeat interval** on the [notification policy](Notifications.md) - This reduces re-notification frequency without changing how the rule evaluates. --- @@ -112,10 +112,10 @@ This page covers common issues when setting up and operating FusionReactor alert **Fixes:** -1. **Grouping** — Ensure your [notification policy](Notifications.md) has appropriate **Group by** labels (such as, `alertname` or `cluster`). This bundles related alerts into a single notification. -2. **Repeat interval** — Increase the **Repeat interval** on the notification policy (default `4h`). This controls how often a persistently firing alert re-notifies. -3. **Group wait / Group interval** — Increasing these values batches notifications over a longer window before sending. -4. **Flapping metric** — If the alert is repeatedly firing and resolving, see [Alert is flapping](#alert-is-flapping) above. +1. **Grouping** - Ensure your [notification policy](Notifications.md) has appropriate **Group by** labels (such as, `alertname` or `cluster`). This bundles related alerts into a single notification. +2. **Repeat interval** - Increase the **Repeat interval** on the notification policy (default `4h`). This controls how often a persistently firing alert re-notifies. +3. **Group wait / Group interval** - Increasing these values batches notifications over a longer window before sending. +4. **Flapping metric** - If the alert is repeatedly firing and resolving, see [Alert is flapping](#alert-is-flapping) above. --- @@ -140,6 +140,6 @@ This page covers common issues when setting up and operating FusionReactor alert **Common causes:** -1. **No folder selected** — Every alert rule must be placed in a folder. If none exist, click **+ New folder** in the rule editor to create one. -2. **No evaluation group selected** — The rule must belong to an evaluation group. Create a new group if needed and set an evaluation interval (such as, `1m`). -3. **Invalid query** — If the query editor shows an error, the rule cannot be saved. Use the **Preview** button to validate your query before saving. +1. **No folder selected** - Every alert rule must be placed in a folder. If none exist, click **+ New folder** in the rule editor to create one. +2. **No evaluation group selected** - The rule must belong to an evaluation group. Create a new group if needed and set an evaluation interval (such as, `1m`). +3. **Invalid query** - If the query editor shows an error, the rule cannot be saved. Use the **Preview** button to validate your query before saving. diff --git a/docs/Data-insights/Features/Deep/Create-Tracepoint.md b/docs/Data-insights/Features/Deep/Create-Tracepoint.md index 4214e3f..329d34f 100644 --- a/docs/Data-insights/Features/Deep/Create-Tracepoint.md +++ b/docs/Data-insights/Features/Deep/Create-Tracepoint.md @@ -19,7 +19,7 @@ To create a tracepoint, open **Explore**, select the **Deep** data source, and n ![!Screenshot](/Monitor-your-data/Deep/images/create.png) -You now need to configure the tracepoint to trigger as required. To do this, you **must** set the file path and line number— all other settings are optional. +You now need to configure the tracepoint to trigger as required. To do this, you **must** set the file path and line number- all other settings are optional. ![!Screenshot](/Monitor-your-data/Deep/images/tracepoint-details.png) diff --git a/docs/Data-insights/Features/Explore-servers.md b/docs/Data-insights/Features/Explore-servers.md index 1059e00..e21674a 100644 --- a/docs/Data-insights/Features/Explore-servers.md +++ b/docs/Data-insights/Features/Explore-servers.md @@ -142,7 +142,7 @@ Graphs include: * Request and error rates * Database and trace throughput -This helps with **root-cause analysis** — understanding what led to a performance change or incident. +This helps with **root-cause analysis** - understanding what led to a performance change or incident. ### Metric graph actions @@ -164,7 +164,7 @@ These actions provide quick access to troubleshooting and monitoring capabilitie ### Threshold Configuration -The **Configuration** page allows you to set and manage warning and critical thresholds for key performance metrics across your application. Thresholds help you identify performance degradation early — when a metric exceeds a configured limit, it triggers visual alerts in dashboards and monitoring panels. +The **Configuration** page allows you to set and manage warning and critical thresholds for key performance metrics across your application. Thresholds help you identify performance degradation early - when a metric exceeds a configured limit, it triggers visual alerts in dashboards and monitoring panels. You can adjust thresholds individually on certain graphs using the icon in the top right, or view and edit all thresholds in one place via **Quick Nav** → **Configuration**. diff --git a/docs/Data-insights/Features/FR-Agent-Metrics.md b/docs/Data-insights/Features/FR-Agent-Metrics.md index 03f9224..9b1ef9c 100644 --- a/docs/Data-insights/Features/FR-Agent-Metrics.md +++ b/docs/Data-insights/Features/FR-Agent-Metrics.md @@ -36,7 +36,7 @@ These labels are automatically attached to each metric and do not need to be con Some metrics also include **[additional labels](/Data-insights/Features/FR-Agent-Metrics/#labels)** to provide more specific context. For example: * `jvm_threads_state` includes a `state` label (e.g. `RUNNABLE`, `WAITING`, `BLOCKED`). -* `fr_cf_requests_throughput_error_time` may include `status` to distinguish between successful vs. failed requests (e.g., 200, 404, 500) and `type` to categorize request origin or type — such as api, static, internal, etc. +* `fr_cf_requests_throughput_error_time` may include `status` to distinguish between successful vs. failed requests (e.g., 200, 404, 500) and `type` to categorize request origin or type - such as api, static, internal, etc. When extra labels are used, they are shown in the **Labels** column of the tables below. If a metric only uses the default labels, this is marked as **Default**. diff --git a/docs/Data-insights/Features/JDBC/JDBC-Monitoring.md b/docs/Data-insights/Features/JDBC/JDBC-Monitoring.md index a73c087..99110c0 100644 --- a/docs/Data-insights/Features/JDBC/JDBC-Monitoring.md +++ b/docs/Data-insights/Features/JDBC/JDBC-Monitoring.md @@ -158,7 +158,7 @@ If enabled, FusionReactor disables autocommit for all statements from this data - Provided as a workaround for certain J2EE servers that require autocommit to be disabled. -- Not recommended for general use—must be tested carefully to ensure transactional integrity. +- Not recommended for general use-must be tested carefully to ensure transactional integrity. ## Specifying JDBC Monitoring Options0 diff --git a/docs/Data-insights/Features/Logs/Log-Archives.md b/docs/Data-insights/Features/Logs/Log-Archives.md index 9f4be51..4bd447b 100644 --- a/docs/Data-insights/Features/Logs/Log-Archives.md +++ b/docs/Data-insights/Features/Logs/Log-Archives.md @@ -38,7 +38,7 @@ found in the [Log Settings](Settings.md) section. ## Clear All Archives -To delete all archives, click **Clear All Archives**. You’ll be asked to confirm—select Yes to remove every archive from the instance’s archive folder. +To delete all archives, click **Clear All Archives**. You’ll be asked to confirm-select Yes to remove every archive from the instance’s archive folder. !!! warning Make sure you are 100% sure before diff --git a/docs/Data-insights/Features/Logs/Logs.md b/docs/Data-insights/Features/Logs/Logs.md index 6135837..96c1ee4 100644 --- a/docs/Data-insights/Features/Logs/Logs.md +++ b/docs/Data-insights/Features/Logs/Logs.md @@ -25,7 +25,7 @@ You can configure: * **Rotation frequency:** create a new folder every *n* minutes, or rotate logs at a specific daily time * **Retention:** limit how much log data is saved by disk usage, time period, or keep all logs if storage allows -The key advantage over the older Traditional method is that it’s easier to batch a complete set of logs for a defined period—useful for comparing logs over time. +The key advantage over the older Traditional method is that it’s easier to batch a complete set of logs for a defined period-useful for comparing logs over time. All settings are configurable on the [Log Settings](/Data-insights/Features/Logs/Settings/) page. diff --git a/docs/Data-insights/Features/Memory/Settings.md b/docs/Data-insights/Features/Memory/Settings.md index 54fdac4..b144716 100644 --- a/docs/Data-insights/Features/Memory/Settings.md +++ b/docs/Data-insights/Features/Memory/Settings.md @@ -14,7 +14,7 @@ The **Heap Histogram settings** control both the live view and snapshot behavior | **UI Row Limit** | Sets the maximum number of rows displayed in the heap view. Very high values may slow down or crash older browsers. | 250 | | **Snapshot Directory** | Directory where heap snapshots are stored. Changing this location does not affect the old directory, which will still exist with its snapshots. New snapshots will be stored in the new directory. | `/heap` | | **Exclude Packages** | A comma - or newline-separated list of packages to exclude from memory snapshots.
Example:
`java.lang`
`java.util` | `com.intergral` | -| **Heap Histogram Timeout** | The maximum time (in milliseconds) the heap histogram scanner runs. This applies only to the native API call (not the UI or browser). Leave empty for no limit—but note this can cause long page generation times on very large heaps. | 1000 | +| **Heap Histogram Timeout** | The maximum time (in milliseconds) the heap histogram scanner runs. This applies only to the native API call (not the UI or browser). Leave empty for no limit-but note this can cause long page generation times on very large heaps. | 1000 | diff --git a/docs/Data-insights/Features/Metrics/AWS-CloudWatch-Metrics.md b/docs/Data-insights/Features/Metrics/AWS-CloudWatch-Metrics.md index 2ab5d56..bfc098b 100644 --- a/docs/Data-insights/Features/Metrics/AWS-CloudWatch-Metrics.md +++ b/docs/Data-insights/Features/Metrics/AWS-CloudWatch-Metrics.md @@ -104,7 +104,7 @@ The columns in this section include: The **Remove** button can be used to stop sending a metric to CloudWatch. -**Stale JMX Metrics** (metrics that have not published a new datapoint recently—usually because the JMX bean has stopped) are listed under the **Stale** tab. +**Stale JMX Metrics** (metrics that have not published a new datapoint recently-usually because the JMX bean has stopped) are listed under the **Stale** tab. To update the dimensions of a metric: diff --git a/docs/Data-insights/Features/Metrics/JMX-MBeans.md b/docs/Data-insights/Features/Metrics/JMX-MBeans.md index 8903f68..fa06760 100644 --- a/docs/Data-insights/Features/Metrics/JMX-MBeans.md +++ b/docs/Data-insights/Features/Metrics/JMX-MBeans.md @@ -57,7 +57,7 @@ Attributes for the selected MBean are displayed in a table: | Name | Description | | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Name** | The JMX-registered name of the attribute, often represented in **camelCase**. | -| **Value** | The current value of the attribute. If the value is not a simple type, FusionReactor attempts to display it logically (for example, arrays are shown in square brackets). Values marked as **changeable** by the JMX instrumentation are editable—press **Return** to commit changes back to the server.

**Caution:** Modifying JMX-instrumented values is not recommended unless you fully understand the effects. These changes are often intended for internal testing and can have unintended consequences if altered incorrectly. | +| **Value** | The current value of the attribute. If the value is not a simple type, FusionReactor attempts to display it logically (for example, arrays are shown in square brackets). Values marked as **changeable** by the JMX instrumentation are editable-press **Return** to commit changes back to the server.

**Caution:** Modifying JMX-instrumented values is not recommended unless you fully understand the effects. These changes are often intended for internal testing and can have unintended consequences if altered incorrectly. | | **Type** | The Java type of the tracked attribute. ### JMX MBean Tracking diff --git a/docs/Data-insights/Features/OpsPilot/AIoverview.md b/docs/Data-insights/Features/OpsPilot/AIoverview.md index a33706c..b28c7d7 100644 --- a/docs/Data-insights/Features/OpsPilot/AIoverview.md +++ b/docs/Data-insights/Features/OpsPilot/AIoverview.md @@ -27,7 +27,7 @@ The latest version of OpsPilot introduces a suite of advanced capabilities desig - **Actionable recommendations** – Prioritizes fixes and next steps to help you focus on what matters most. -- **Seamless integrations** – Works with Microsoft Teams, Jira, and Slack — and can automatically create tickets to accelerate issue resolution. +- **Seamless integrations** – Works with Microsoft Teams, Jira, and Slack - and can automatically create tickets to accelerate issue resolution. - **OpsPilot Vision** – Allows you to upload screenshots from FusionReactor, Grafana, or similar tools for instant, readable insights. @@ -51,7 +51,7 @@ Engage with OpsPilot anytime through the interactive chat interface. Simply sele - Retrieve external patch, release, and version data. -**OpsPilot communicates naturally — so you can ask things like:** +**OpsPilot communicates naturally - so you can ask things like:** - “What’s causing memory spikes in the last hour?” - “Show me slow transaction trends this week.” diff --git a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Knowledge.md b/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Knowledge.md index 9b58bee..7f5bd90 100644 --- a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Knowledge.md +++ b/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Knowledge.md @@ -1,86 +1,72 @@ +# Knowledge +The **Knowledge** page lets you build a context library for the OpsPilot AI assistant. By adding information about your technology stack, services, and organisation, you help OpsPilot give more accurate, relevant responses and recommendations. -The Knowledge section in OpsPilot allows you to add general information that helps the system understand your entire technology stack and organization. This feature enhances OpsPilot's ability to provide relevant and contextualized responses. +![!Screenshot](/Data-insights/Features/OpsPilot/images/new-knowledge.png) -![!Screenshot](/Data-insights/Features/OpsPilot/images/knowledge.png) - -When adding content to OpsPilot Knowledge, it's crucial to understand that the system relies heavily on titles and descriptions to locate relevant information when answering questions. To maximize the effectiveness of your knowledge base, ensure that your titles and descriptions are comprehensive and accurately reflect all the topics covered in each snippet or document. +Knowledge is stored as **snippets** or **files**, and can be searched, filtered, and tagged to keep your library organised. !!! tip - Always review auto-generated titles and descriptions. If they're incomplete or inaccurate, edit them manually. Precise, detailed titles and descriptions greatly improve OpsPilot's ability to find and use the right information, leading to better, more relevant responses. - -Currently, two types of knowledge can be added to OpsPilot: - -1. [Snippet](/Data-insights/Features/OpsPilot/OpsPilot-Hub/Knowledge/#snippets) - -2. [File](/Data-insights/Features/OpsPilot/OpsPilot-Hub/Knowledge/#files) + OpsPilot relies heavily on titles and descriptions to find the right knowledge when answering questions. Always review auto-generated titles and edit them if they are incomplete - precise titles lead to better responses. +## Adding knowledge +Click **+ Add Knowledge** in the top right and choose the type you want to add. ### Snippets -- Text-based information with a 5,000 character limit. -- Title field is optional (auto-generated based on content if not provided). -!!! tip - We advise splitting detailed information into multiple snippets. - -!!! Example - Instructions for configuring logging, README files, Customer support questions, QA, company names and roles. +Snippets are short pieces of text you write directly in OpsPilot - ideal for service descriptions, team context, configuration notes, or any information you want the assistant to reference. +- Maximum 5,000 characters per snippet +- Title is optional and will be auto-generated from content if not provided -#### Adding a snippet +!!! tip + Split detailed information across multiple snippets rather than adding it all in one. Smaller, focused snippets improve retrieval accuracy. -1. Open the OpsPilot Hub interface. -1. Click the **Add Knowledge** button on the right of your screen and select **Snippet**. The Add snippet interface is displayed. -2. Enter a title for your snippet. (optional) -3. Add the content of your snippet in the **Content** text area. This is where you'll add the short-form text for your knowledge base. -4. Add relevant tags to categorize your snippet. -5. Once you've filled in the necessary information, click the **Add Snippet** button in the bottom right corner to save your snippet to the knowledge base. -6. If you need to cancel the process, click the **Close** button. +!!! example + Logging configuration instructions, README content, support FAQs, company names and roles, service ownership details. +**To add a snippet:** +1. Click **+ Add Knowledge** and select **Snippet**. +2. Enter a title (optional). +3. Add your content in the **Content** field. +4. Add relevant tags to categorise the snippet. +5. Click **Add Snippet** to save. ### Files -- No limit on information quantity. -- Zips have no file limit size, but the files inside them cannot be bigger than 10mb. -- Supports various file types: .txt, .eml, .msg, .xml, .html, .md, .rst, .json, .rtf, .doc, .docx, .ppt, .pptx, .pdf, .odt, .epub, .csv, .tsv, .xlsx, .zip - -#### Adding a file - -1. Open the OpsPilot Hub interface. -2. Click the **Add Knowledge** button on the right of your screen and select **File**. The **Add file** dialog box is displayed. -5. In the **Files** section, either:
- a. Drag and drop files into the box with the open box icon, or
- b. Click anywhere in the box to open a file selection window. -7. In the **Tags** section, add new tags or select relevant tags to categorize your file. -10. Click the **Upload Files** button in the bottom right corner to add the file(s) to your knowledge base. -11. If you need to cancel the process, select the **Close** button. - - - -## Knowledge organization & retrieval - -### Filtering +Files let you upload existing documents directly into the knowledge library - useful for larger reference material that already exists in your organisation. -Filter knowledge sources by: +- Supports: `.txt`, `.eml`, `.msg`, `.xml`, `.html`, `.md`, `.rst`, `.json`, `.rtf`, `.doc`, `.docx`, `.ppt`, `.pptx`, `.pdf`, `.odt`, `.epub`, `.csv`, `.tsv`, `.xlsx`, `.zip` +- No size limit on the upload itself, but individual files inside a zip cannot exceed 10 MB -- Search terms +**To add a file:** -- Types (files/snippets) +1. Click **+ Add Knowledge** and select **File**. +2. Drag and drop your file(s) into the upload area, or click to browse. +3. Add tags to categorise the file. +4. Click **Upload Files** to save. -- Tags +## Searching and filtering -### Tags +Use the search bar to find knowledge by keyword, or use the tabs to filter by type: -Tags are required for filtering and categorizing data in OpsPilot. Custom tags cannot contain ":" characters, as these are reserved for system tags. System tags are automatically generated by OpsPilot and represent system entities. +| Filter | Description | +|---|---| +| **All** | Shows all knowledge entries | +| **Files** | Shows uploaded file entries only | +| **Snippets** | Shows text snippet entries only | -Tags: +## Tags -- Help organize and structure information logically. -- Act as labels to categorize knowledge and improve searchability. -- Provide additional context without altering content. -- Can be assigned to specific services where applicable. +Tags help organise your knowledge library and improve how OpsPilot retrieves information. +- Assign tags when adding a snippet or file +- Use tags to group knowledge by service, team, or topic +- Custom tags cannot contain `:` characters - these are reserved for system-generated tags that OpsPilot assigns automatically +--- +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Data-insights/Features/OpsPilot/OpsPilot-user-guide.md b/docs/Data-insights/Features/OpsPilot/OpsPilot-user-guide.md index 4fdbef9..646d88f 100644 --- a/docs/Data-insights/Features/OpsPilot/OpsPilot-user-guide.md +++ b/docs/Data-insights/Features/OpsPilot/OpsPilot-user-guide.md @@ -2,7 +2,7 @@ # User Guide -OpsPilot is your intelligent AI assistant for full-stack observability. It’s built to help every team member — from developers to operations engineers — understand, diagnose, and optimize complex systems with ease. +OpsPilot is your intelligent AI assistant for full-stack observability. It’s built to help every team member - from developers to operations engineers - understand, diagnose, and optimize complex systems with ease. By combining FusionReactor’s powerful telemetry platform with advanced large language models (LLMs), OpsPilot transforms complex data into clear, actionable insights. It understands the context of your applications, explains what’s happening in natural language, and helps you resolve issues faster. diff --git a/docs/Data-insights/Features/OpsPilot/images/new-knowledge.png b/docs/Data-insights/Features/OpsPilot/images/new-knowledge.png new file mode 100644 index 0000000..6d1623b Binary files /dev/null and b/docs/Data-insights/Features/OpsPilot/images/new-knowledge.png differ diff --git a/docs/Data-insights/Features/alerting-examples.md b/docs/Data-insights/Features/alerting-examples.md index 086a901..cef1e2b 100644 --- a/docs/Data-insights/Features/alerting-examples.md +++ b/docs/Data-insights/Features/alerting-examples.md @@ -1,4 +1,4 @@ -The following examples demonstrate how to create common FusionReactor alert rules using the Grafana Ruler-based alerting system. Each example covers the full configuration — query, condition, folder, evaluation group, No Data handling, and notifications. +The following examples demonstrate how to create common FusionReactor alert rules using the Grafana Ruler-based alerting system. Each example covers the full configuration - query, condition, folder, evaluation group, No Data handling, and notifications. Before following these examples, make sure you have: @@ -12,7 +12,7 @@ There are two ways to route notifications when creating an alert rule: | Approach | When to use | Setup required | | --- | --- | --- | -| **Direct contact point** | You want all notifications from this rule to go to one specific destination. | No extra setup — select the contact point in the rule editor. | +| **Direct contact point** | You want all notifications from this rule to go to one specific destination. | No extra setup - select the contact point in the rule editor. | | **Label-based routing** | You want flexible routing through notification policies (such as, routing by severity or team). | Requires **Advanced Alerting** to be enabled and notification policies configured. See [Notification Policies](Alerting/Notifications.md). | Each example below covers both options in the notifications step. @@ -41,7 +41,7 @@ Enter a name such as `Any Instance Offline`. - Select your FusionReactor data source. - Select the `app_up` metric. Leave instance and job filters unset to monitor all instances. -- Set the alert condition to **IS BELOW 1**. When an instance is online, `app_up` returns `1` — so the condition is false and the alert stays normal. When an instance goes offline, `app_up` drops to `0` or stops reporting entirely, which triggers the alert. +- Set the alert condition to **IS BELOW 1**. When an instance is online, `app_up` returns `1` - so the condition is false and the alert stays normal. When an instance goes offline, `app_up` drops to `0` or stops reporting entirely, which triggers the alert. !!! tip Click **Preview alert rule condition** to confirm data is being returned before continuing. @@ -59,7 +59,7 @@ Under **Configure no data and error handling**, set **No Data** to **Alerting**. **5. Notifications** - **Direct contact point (simple):** Under **Notifications**, select your contact point directly from the **Contact point** dropdown. -- **Label-based routing (advanced alerting):** Leave the contact point unset and add a label to route through your notification policies — for example, `channel` = `slack`. +- **Label-based routing (advanced alerting):** Leave the contact point unset and add a label to route through your notification policies - for example, `channel` = `slack`. **6. Annotations** @@ -84,13 +84,13 @@ Navigate to **Alerting** > **Alert rules** and click **+ New alert rule**. **1. Name** -Enter a name such as `Instance Offline — [instance name]`. +Enter a name such as `Instance Offline - [instance name]`. **2. Query and condition** - Select your FusionReactor data source. - Select the `app_up` metric and filter by the specific **Job** or **Instance** label you want to monitor (such as, `instance = "production-server-01"`). -- Set the alert condition to **IS BELOW 1**. When the instance is online, `app_up` returns `1` — so the condition is false and the alert stays normal. When the instance goes offline, `app_up` drops to `0` or stops reporting, which triggers the alert. +- Set the alert condition to **IS BELOW 1**. When the instance is online, `app_up` returns `1` - so the condition is false and the alert stays normal. When the instance goes offline, `app_up` drops to `0` or stops reporting, which triggers the alert. !!! tip Click **Preview alert rule condition** to confirm data is being returned before continuing. @@ -108,7 +108,7 @@ Under **Configure no data and error handling**, set **No Data** to **Alerting**. **5. Notifications** - **Direct contact point (simple):** Under **Notifications**, select your contact point directly from the **Contact point** dropdown. -- **Label-based routing (advanced alerting):** Leave the contact point unset and add a label to route through your notification policies — for example, `channel` = `slack`. +- **Label-based routing (advanced alerting):** Leave the contact point unset and add a label to route through your notification policies - for example, `channel` = `slack`. **6. Annotations** @@ -128,7 +128,7 @@ Click **Save rule and exit**. This rule fires when any FusionReactor instance sustains high system CPU usage, helping you catch runaway processes or capacity issues before they affect users. !!! tip - You can also use a **less than** threshold for underflow alerts — for example, alert when request volume drops below a baseline. This is useful for high-traffic services where unexpectedly low activity may indicate requests are not reaching the service. + You can also use a **less than** threshold for underflow alerts - for example, alert when request volume drops below a baseline. This is useful for high-traffic services where unexpectedly low activity may indicate requests are not reaching the service. #### Configuration @@ -136,7 +136,7 @@ Navigate to **Alerting** > **Alert rules** and click **+ New alert rule**. **1. Name** -Enter a name such as `High CPU — Any Instance`. +Enter a name such as `High CPU - Any Instance`. **2. Query and condition** @@ -156,7 +156,7 @@ Enter a name such as `High CPU — Any Instance`. **4. Notifications** - **Direct contact point (simple):** Under **Notifications**, select your contact point directly from the **Contact point** dropdown. -- **Label-based routing (advanced alerting):** Leave the contact point unset and add a label to route through your notification policies — for example, `channel` = `slack`. +- **Label-based routing (advanced alerting):** Leave the contact point unset and add a label to route through your notification policies - for example, `channel` = `slack`. **5. Annotations** @@ -175,7 +175,7 @@ Click **Save rule and exit**. This rule monitors memory allocation across all instances sharing a specific group label, and fires when any of them sustains high memory usage for an extended period. -Instances can be assigned a group in FusionReactor, which appears as a label on their metrics. Filtering by group lets you scope an alert to a logical subset of your estate — for example, all instances in a production environment or a specific application tier. +Instances can be assigned a group in FusionReactor, which appears as a label on their metrics. Filtering by group lets you scope an alert to a logical subset of your estate - for example, all instances in a production environment or a specific application tier. #### Configuration @@ -183,7 +183,7 @@ Navigate to **Alerting** > **Alert rules** and click **+ New alert rule**. **1. Name** -Enter a name such as `High Memory — [Group Name] Group`. +Enter a name such as `High Memory - [Group Name] Group`. **2. Query and condition** @@ -199,12 +199,12 @@ Enter a name such as `High Memory — [Group Name] Group`. - Select or create a folder. - Select or create an evaluation group with an interval of `1m`. -- Set the **Pending period** to `10m`. This prevents noise from short-lived spikes — the alert only fires if memory pressure is sustained for 10 full minutes. +- Set the **Pending period** to `10m`. This prevents noise from short-lived spikes - the alert only fires if memory pressure is sustained for 10 full minutes. **4. Notifications** - **Direct contact point (simple):** Under **Notifications**, select your contact point directly from the **Contact point** dropdown. -- **Label-based routing (advanced alerting):** Leave the contact point unset and add a label to route through your notification policies — for example, `channel` = `slack`. +- **Label-based routing (advanced alerting):** Leave the contact point unset and add a label to route through your notification policies - for example, `channel` = `slack`. **5. Annotations** @@ -247,7 +247,7 @@ Navigate to **Alerting** > **Alert rules** and click **+ New alert rule**. **1. Name** -Enter a name such as `On-Demand Charges — [Service Name]`. +Enter a name such as `On-Demand Charges - [Service Name]`. **2. Query and condition** @@ -267,7 +267,7 @@ Enter a name such as `On-Demand Charges — [Service Name]`. **4. Notifications** - **Direct contact point (simple):** Under **Notifications**, select your contact point directly from the **Contact point** dropdown. -- **Label-based routing (advanced alerting):** Leave the contact point unset and add a routing label — for example, `channel` = `email`. +- **Label-based routing (advanced alerting):** Leave the contact point unset and add a routing label - for example, `channel` = `email`. **5. Annotations** @@ -292,7 +292,7 @@ Navigate to **Alerting** > **Alert rules** and click **+ New alert rule**. **1. Name** -Enter a name such as `Billable Data Usage — [Service Name]`. +Enter a name such as `Billable Data Usage - [Service Name]`. **2. Query and condition** @@ -312,7 +312,7 @@ Enter a name such as `Billable Data Usage — [Service Name]`. **4. Notifications** - **Direct contact point (simple):** Under **Notifications**, select your contact point directly from the **Contact point** dropdown. -- **Label-based routing (advanced alerting):** Leave the contact point unset and add a routing label — for example, `channel` = `email`. +- **Label-based routing (advanced alerting):** Leave the contact point unset and add a routing label - for example, `channel` = `email`. **5. Annotations** @@ -337,7 +337,7 @@ Navigate to **Alerting** > **Alert rules** and click **+ New alert rule**. **1. Name** -Enter a name such as `Total Billing Charges — [Service Name]`. +Enter a name such as `Total Billing Charges - [Service Name]`. **2. Query and condition** @@ -357,7 +357,7 @@ Enter a name such as `Total Billing Charges — [Service Name]`. **4. Notifications** - **Direct contact point (simple):** Under **Notifications**, select your contact point directly from the **Contact point** dropdown. -- **Label-based routing (advanced alerting):** Leave the contact point unset and add a routing label — for example, `channel` = `email`. +- **Label-based routing (advanced alerting):** Leave the contact point unset and add a routing label - for example, `channel` = `email`. **5. Annotations** diff --git a/docs/Data-insights/Features/database.md b/docs/Data-insights/Features/database.md new file mode 100644 index 0000000..eb7f36d --- /dev/null +++ b/docs/Data-insights/Features/database.md @@ -0,0 +1,60 @@ +# Database + +The **Database** page gives you full visibility into how your databases are performing across your entire environment. Use it to pinpoint slow or expensive queries, detect errors before users report them, understand which applications are generating the most database load, and compare performance across multiple instances - all from a single dashboard. + +## Filters + +Use the filter bar to focus the dashboard on exactly what you need: + +| Filter | Description | +|---|---| +| **Job** | Isolate metrics for a specific job label | +| **Application Name** | See which application is responsible for the database traffic | +| **Instance** | Compare performance across individual database instances | +| **Database** | Drill into a specific database by name | +| **Action** | Filter by SQL action type (e.g. SELECT, INSERT) | +| **TopK** | Limit results to the top K entries by value | +| **Time range** | Control the time window for all panels - defaults to the last 1 hour but can be adjusted to cover longer periods for trend analysis | + +## Tabs + +| Tab | Description | +|---|---| +| **Metrics** | Pre-built panels showing database performance metrics | +| **Traces** | Distributed traces for individual database calls | +| **Integrations** | View database integration status | +| **Kubernetes** | Database metrics scoped to Kubernetes workloads | +| **Anomaly Detection** | Anomaly alerts detected on database signals | +| **Custom** | Add and arrange your own panels | + +## Metrics panels + +### Database Time Spent on Commands + +Shows the proportion of total execution time spent on each command type (e.g. SELECT, INSERT). If one command type dominates - for example SELECT accounting for 95% of time - this is a strong signal of where to focus optimisation efforts. + +### Database Throughput by Job / Application / Instance + +Tracks the rate of database commands per minute over time. Use this to identify which services are generating the most database traffic, spot unexpected spikes, and support capacity planning decisions. + +### Database Errors by Job / Application / Instance + +Shows the rate of database errors per minute. Spikes here typically precede or coincide with user-facing failures - catching them early means you can act before users report problems. + +### Database Query Throughput per Job / Application / Instance + +Shows query volume per minute broken down by job, application, and instance. Useful for understanding load distribution and identifying a specific application that may be overwhelming the database. + +### Database Total Query Time by Command / Job / Application / Instance + +Shows cumulative query execution time broken down by SQL command, job, application, and instance. This is the most direct panel for identifying slow or expensive query patterns - a sharp increase here points to a query that needs attention. + +--- + +!!! tip "Troubleshooting slow applications" + If an application feels sluggish, filter by **Application Name** and check the Total Query Time and Error panels first. A spike in either confirms the database is the bottleneck. + +--- + +!!! question "Need more help?" + Contact support in the chat bubble and let us know how we can assist. diff --git a/docs/Data-insights/Features/explore-logs.md b/docs/Data-insights/Features/explore-logs.md index c217362..e5bd013 100644 --- a/docs/Data-insights/Features/explore-logs.md +++ b/docs/Data-insights/Features/explore-logs.md @@ -2,7 +2,7 @@ -FusionReactor’s **Logs Drilldown** makes log exploration effortless with an intuitive, no-query interface. It automatically turns your log data into interactive visualizations, enabling engineers of all experience levels to investigate and gain insights—no LogQL required. +FusionReactor’s **Logs Drilldown** makes log exploration effortless with an intuitive, no-query interface. It automatically turns your log data into interactive visualizations, enabling engineers of all experience levels to investigate and gain insights-no LogQL required. ![!Screenshot](../../Data-insights/Features/images/logs-main.png) diff --git a/docs/Data-insights/Features/explore-metrics.md b/docs/Data-insights/Features/explore-metrics.md index 162fc61..21ebd2c 100644 --- a/docs/Data-insights/Features/explore-metrics.md +++ b/docs/Data-insights/Features/explore-metrics.md @@ -67,7 +67,7 @@ To start: ### Open a metric in Explore -Explore lets you interact with your data in real time. You can build, test, and refine queries without needing to create a dashboard. If your data source supports it, you’ll see results in both graph and table views—perfect for quick and detailed analysis. +Explore lets you interact with your data in real time. You can build, test, and refine queries without needing to create a dashboard. If your data source supports it, you’ll see results in both graph and table views-perfect for quick and detailed analysis. To drill deeper into a specific metric using Explore: @@ -84,7 +84,7 @@ To drill deeper into a specific metric using Explore: ![!Screenshot](../../Data-insights/Features/images/explore-metrics.png) -Explore is great for experimenting with queries and uncovering deeper insights—without needing to build a full dashboard. +Explore is great for experimenting with queries and uncovering deeper insights-without needing to build a full dashboard. ### Add metrics visualization to a dashboard diff --git a/docs/Data-insights/Features/explore-traces.md b/docs/Data-insights/Features/explore-traces.md index fc546da..ae37c98 100644 --- a/docs/Data-insights/Features/explore-traces.md +++ b/docs/Data-insights/Features/explore-traces.md @@ -1,6 +1,6 @@ ## Overview -Distributed traces enable you to monitor and troubleshoot applications by following the path of requests as they travel through various services. Each trace captures detailed information about a request—such as timing, errors, and service interactions - providing valuable context to help you diagnose performance issues or pinpoint failures. +Distributed traces enable you to monitor and troubleshoot applications by following the path of requests as they travel through various services. Each trace captures detailed information about a request-such as timing, errors, and service interactions - providing valuable context to help you diagnose performance issues or pinpoint failures. FusionReactor's **Traces** feature enhances your observability workflow by offering intuitive visualizations of trace data collected by Grafana Tempo. It helps you quickly identify bottlenecks, latency spikes, and service dependencies, giving you actionable insights directly from your distributed traces. diff --git a/docs/Data-insights/Features/overview.md b/docs/Data-insights/Features/overview.md index c7e7b45..6de6780 100644 --- a/docs/Data-insights/Features/overview.md +++ b/docs/Data-insights/Features/overview.md @@ -1,32 +1,7 @@ # Overview - - The **Overview** page is your observability dashboard at a glance. It gives you an immediate, high-level summary of your entire environment - services, servers, applications, alerts, anomaly detection, and usage - all in one place. -## New account view - -If your account has no data yet, each section of the Overview displays a **Get Started** prompt to guide you through setup: - -![!Screenshot](../../Data-insights/Features/images/New-account-overview.png) - -| Section | Prompt | -|---|---| -| **Services** | You'll need an API key to instrument your application with OpenTelemetry. | -| **Servers** | Install FusionReactor on your servers to start monitoring. You'll need a license key. | -| **Applications** | Install FusionReactor to monitor your applications. You'll need a license key. | -| **Alerts** | Configure alert rules to monitor your infrastructure. | -| **Anomaly Detection** | Enable anomaly detection to automatically detect unusual behavior in your data. | - -The **Servers** and **Applications** prompts also display your **FusionReactor Cloud license key** directly on the page so you can copy it for use during agent installation. - -The **Usage** panel shows your plan limits with all values at zero until data starts flowing (for example, `0 bytes / 27 GB` for Logs). - -Once data starts flowing in, the Overview automatically populates with your live metrics and telemetry. - -!!! tip "Getting started" - Follow the prompts on the Overview page to install the right agent or instrumentation for your stack, then return to the Overview to see your data appear. - ## Active account view Once your environment is sending data, the Overview page shows a full observability summary. @@ -70,7 +45,7 @@ The **Servers** section provides a summary of all servers running a FusionReacto **Servers by latency** lists your top servers ranked by average latency, with CPU and memory breakdowns per server. -Click **Servers →** to go to the full [Servers](/Data-insights/Features/servers/) view. +Click **Servers ->** to go to the full [Servers](/Data-insights/Features/servers/) view. ### Applications @@ -83,7 +58,7 @@ The **Applications** section summarises all monitored applications, showing: **Applications by latency** lists your top applications ranked by average latency. -Click **Applications →** to go to the full [Applications](/Data-insights/Features/applications/) view. +Click **Applications ->** to go to the full [Applications](/Data-insights/Features/applications/) view. ### Alerts @@ -96,13 +71,13 @@ The **Alerts** panel shows a live count of alerts grouped by state: | **Recovering** | Alerts returning to a normal state | | **Normal** | Alert rules currently within threshold | -Click **Alerts →** to go to the full [Alerts](/Data-insights/Features/Alerting/Active-alerts/) view. +Click **Alerts ->** to go to the full [Alerts](/Data-insights/Features/Alerting/Active-alerts/) view. ### Anomaly Detection The **Anomaly Detection** panel shows a live count of anomaly alerts by state, mirroring the same Firing / Pending / Recovering / Normal breakdown. -Click **Anomaly Detection →** to go to the full [Anomaly Detection](/Data-insights/Features/Anomaly-Detection/ADoverview/) view. +Click **Anomaly Detection ->** to go to the full [Anomaly Detection](/Data-insights/Features/Anomaly-Detection/ADoverview/) view. ### Usage @@ -118,6 +93,29 @@ The **Usage** panel shows your current consumption against your plan limits for A progress bar indicates how much of your plan allowance has been used. +## No Data view + +If your account has no data yet, each section of the Overview displays a **Get Started** prompt to guide you through setup: + +![!Screenshot](../../Data-insights/Features/images/New-account-overview.png) + +| Section | Prompt | +|---|---| +| **Services** | You'll need an API key to instrument your application with OpenTelemetry. | +| **Servers** | Install FusionReactor on your servers to start monitoring. You'll need a license key. | +| **Applications** | Install FusionReactor to monitor your applications. You'll need a license key. | +| **Alerts** | Configure alert rules to monitor your infrastructure. | +| **Anomaly Detection** | Enable anomaly detection to automatically detect unusual behavior in your data. | + +The **Servers** and **Applications** prompts also display your **FusionReactor Cloud license key** directly on the page so you can copy it for use during agent installation. + +The **Usage** panel shows your plan limits with all values at zero until data starts flowing (for example, `0 bytes / 27 GB` for Logs). + +Once data starts flowing in, the Overview automatically populates with your live metrics and telemetry. + +!!! tip "Getting started" + Follow the prompts on the Overview page to install the right agent or instrumentation for your stack, then return to the Overview to see your data appear. + --- !!! question "Need more help?" diff --git a/docs/Getting-started/Tutorials/crash-troubleshoot-cloud.md b/docs/Getting-started/Tutorials/crash-troubleshoot-cloud.md index af16a84..7820d1f 100644 --- a/docs/Getting-started/Tutorials/crash-troubleshoot-cloud.md +++ b/docs/Getting-started/Tutorials/crash-troubleshoot-cloud.md @@ -22,8 +22,8 @@ This guide explains how to use **FusionReactor Cloud** to diagnose and prevent a | Feature | Description | |-------------------------|-----------------------------------------------------------------------------| -| **Historic Metrics** | Retained for **13 months** — accessible even after server restarts. | -| **Traces & Logs** | Stored for **30 days** — detailed transaction-level visibility. | +| **Historic Metrics** | Retained for **13 months** - accessible even after server restarts. | +| **Traces & Logs** | Stored for **30 days** - detailed transaction-level visibility. | | **Anomaly Detection** | Uses R.E.D. metrics to automatically flag unusual application behavior. | | **Custom Alerts** | User-defined thresholds for memory, latency, CPU, and uptime monitoring. | @@ -123,7 +123,7 @@ Get real-time alerts to act quickly when thresholds are breached. By following this process, you can: -- Identify the specific cause of a crash — whether memory, CPU, thread, or database related. +- Identify the specific cause of a crash - whether memory, CPU, thread, or database related. - Correlate data between metrics, transactions, and logs. - Configure automated alerts to catch early warning signs and avoid recurrence. diff --git a/docs/Getting-started/install-fr.md b/docs/Getting-started/install-fr.md index 3ef38b3..dcd2ac7 100644 --- a/docs/Getting-started/install-fr.md +++ b/docs/Getting-started/install-fr.md @@ -30,7 +30,7 @@ The **automated installation** deploys the FusionReactor Administration Manager, #### **Benefits** -- Simplifies configuration—no need to modify files manually. +- Simplifies configuration-no need to modify files manually. - Allows setting an instance password before running it. - Provides access control over specific ports or IP addresses. diff --git a/docs/Getting-started/set-up-integrations.md b/docs/Getting-started/set-up-integrations.md index 61cdc91..8b08400 100644 --- a/docs/Getting-started/set-up-integrations.md +++ b/docs/Getting-started/set-up-integrations.md @@ -6,13 +6,13 @@ Welcome to the **Set up integrations** guide. This page introduces the **Observa ## Observability Agent overview -The **Observability Agent** by FusionReactor is built as a wrapper around **Grafana Alloy**, providing a simplified way to forward metrics from various parts of your tech stack to **FusionReactor Cloud** — all with minimal configuration. +The **Observability Agent** by FusionReactor is built as a wrapper around **Grafana Alloy**, providing a simplified way to forward metrics from various parts of your tech stack to **FusionReactor Cloud** - all with minimal configuration. ### Key features -- **Centralized Monitoring**: Collect metrics from across your entire stack — ColdFusion, Java, databases, servers, containers, and more. +- **Centralized Monitoring**: Collect metrics from across your entire stack - ColdFusion, Java, databases, servers, containers, and more. - **Simple Installation**: Deploy quickly using **FRAM**, **Docker**, or install snippets. - **Cloud Dashboards**: Visualize data in **Explore** and the **Integration Dashboards** in FusionReactor Cloud. diff --git a/docs/Latest-updates/Releases.md b/docs/Latest-updates/Releases.md index 97432ce..a08277e 100644 --- a/docs/Latest-updates/Releases.md +++ b/docs/Latest-updates/Releases.md @@ -177,7 +177,7 @@ We're excited to unveil the latest enhancements to FusionReactor's servers view, ## Oracle Database Monitor -Introducing the latest advancement in monitoring capabilities — FusionReactor's cutting-edge integration with Oracle Database which uses metrics you can easily send to FusionReactor using the [Observability Agent](/Monitor-your-data/Observability-agent/overview/). Seamlessly embedded within the FusionReactor ecosystem, the Oracle Database Monitor offers comprehensive visibility into critical database metrics, query execution times, resource utilization, and more. Try FusionReactor's Oracle Database integration to collect key performance metrics on databases, tablespaces, and memory by default and experience firsthand the transformative potential of enhanced Oracle monitoring. +Introducing the latest advancement in monitoring capabilities - FusionReactor's cutting-edge integration with Oracle Database which uses metrics you can easily send to FusionReactor using the [Observability Agent](/Monitor-your-data/Observability-agent/overview/). Seamlessly embedded within the FusionReactor ecosystem, the Oracle Database Monitor offers comprehensive visibility into critical database metrics, query execution times, resource utilization, and more. Try FusionReactor's Oracle Database integration to collect key performance metrics on databases, tablespaces, and memory by default and experience firsthand the transformative potential of enhanced Oracle monitoring. diff --git a/docs/Latest-updates/WhatsNew.md b/docs/Latest-updates/WhatsNew.md index b32f737..c246c6b 100644 --- a/docs/Latest-updates/WhatsNew.md +++ b/docs/Latest-updates/WhatsNew.md @@ -6,7 +6,7 @@ FusionReactor Cloud is officially becoming **OpsPilot**. -Your account, pricing, integrations, and support team remain exactly as they were. What's changing is the identity of the platform — and for good reason. +Your account, pricing, integrations, and support team remain exactly as they were. What's changing is the identity of the platform - and for good reason. OpsPilot has been the AI engine at the heart of the product for the past three years. As the platform grew to proactively guide teams, score stack health, investigate incidents, and deliver prioritised recommendations, it became clear that OpsPilot wasn't just a feature. It was the product. The rename reflects that reality. @@ -28,7 +28,7 @@ Alongside the rebrand, this is the biggest UI update in FusionReactor's history: ### What comes next -The roadmap for 2026 is anchored around AI and OpenTelemetry — deeper AI-powered investigation and root cause analysis, broader OpenTelemetry support across languages and frameworks, and more intelligence built into every layer of the product. +The roadmap for 2026 is anchored around AI and OpenTelemetry - deeper AI-powered investigation and root cause analysis, broader OpenTelemetry support across languages and frameworks, and more intelligence built into every layer of the product. ### FusionReactor 2025.2.1 released @@ -77,13 +77,13 @@ This feature transforms OpsPilot from a monitoring assistant into a true root ca ## Model Context Protocol (MCP) Support in FusionReactor -FusionReactor now supports the Model Context Protocol (MCP) — a vendor-neutral standard that allows AI tools to securely connect with external systems in real time. MCP enables AI models to access up-to-date information and even interact with supported tools. +FusionReactor now supports the Model Context Protocol (MCP) - a vendor-neutral standard that allows AI tools to securely connect with external systems in real time. MCP enables AI models to access up-to-date information and even interact with supported tools. ### FR Cloud MCP
- Connect AI assistants like Claude Desktop directly to your FusionReactor Cloud data using MCP. Gain real-time insights, run queries, and integrate FR Cloud with your AI workflows — powered by the open-source Grafana MCP project. + Connect AI assistants like Claude Desktop directly to your FusionReactor Cloud data using MCP. Gain real-time insights, run queries, and integrate FR Cloud with your AI workflows - powered by the open-source Grafana MCP project.
@@ -126,7 +126,7 @@ We’ve added a new way to investigate issues by exploring logs directly inside **Highlights:** -* Instantly see log volume and sample log lines when opening Explore Logs — no more blank screen. +* Instantly see log volume and sample log lines when opening Explore Logs - no more blank screen. * Browse labels and detected fields with volume and distribution insights; refine results without writing LogQL. * Spot common patterns to filter noise or focus on anomalies. @@ -158,7 +158,7 @@ We’re excited to announce the availability of Traces Drilldown in Explore, de You now have more control over your queries in OpsPilot with the new **Web Search Toggle**! -Easily **enable or disable web search** depending on your needs — perfect for switching between private/internal topics and general web lookups. +Easily **enable or disable web search** depending on your needs - perfect for switching between private/internal topics and general web lookups. **Where to find it:** Look for the **globe icon** next to the mic in the chat bar. diff --git a/docs/Monitor-your-data/Katie/overview.md b/docs/Monitor-your-data/Katie/overview.md index b47e9d6..cf23490 100644 --- a/docs/Monitor-your-data/Katie/overview.md +++ b/docs/Monitor-your-data/Katie/overview.md @@ -48,7 +48,7 @@ As a cluster administrator, you’ll need to install the Katie Agent in each Kub ### Katie MCP -Once the agent is installed, you can use the Katie MCP with any compatible MCP host — such as Claude Desktop — to interact with your cluster and gain real-time insights into its performance. +Once the agent is installed, you can use the Katie MCP with any compatible MCP host - such as Claude Desktop - to interact with your cluster and gain real-time insights into its performance. !!! info [Installing Katie MCP](/Monitor-your-data/Katie/install/) \ No newline at end of file diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/PHP.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/PHP.md index 5b773d3..699786c 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/PHP.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/PHP.md @@ -96,7 +96,7 @@ $loggerProvider = LoggerProvider::builder() ->addLogRecordProcessor(new SimpleLogRecordProcessor($logsExporter)) ->build(); -// Register all providers globally (single call — avoids overwriting) +// Register all providers globally (single call - avoids overwriting) Sdk::builder() ->setTracerProvider($tracerProvider) ->setMeterProvider($meterProvider) diff --git a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/node.md b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/node.md index 95537e2..ef3be06 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Instrumentation/node.md +++ b/docs/Monitor-your-data/OpenTelemetry/Instrumentation/node.md @@ -18,7 +18,7 @@ This guide demonstrates how to instrument a Node.js application with OpenTelemet Create a new directory for your project and add the following files. -**`package.json`** — defines the project and its OpenTelemetry dependencies: +**`package.json`** - defines the project and its OpenTelemetry dependencies: ```json { @@ -43,7 +43,7 @@ Create a new directory for your project and add the following files. } ``` -**`Dockerfile`** — builds and runs the application: +**`Dockerfile`** - builds and runs the application: ```dockerfile FROM node:18-alpine diff --git a/docs/Monitor-your-data/OpenTelemetry/Visualize/Distributed-tracing.md b/docs/Monitor-your-data/OpenTelemetry/Visualize/Distributed-tracing.md index 9953f0a..093e6da 100644 --- a/docs/Monitor-your-data/OpenTelemetry/Visualize/Distributed-tracing.md +++ b/docs/Monitor-your-data/OpenTelemetry/Visualize/Distributed-tracing.md @@ -16,7 +16,7 @@ FusionReactor Cloud is able to provide distributed trace information which is ca Distributed tracing occurs when a single request is assigned a unique trace ID. As user requests travel through a distributed system, sets of spans are generated for every new operation that is required on the journey. -Multiple functions are performed on the request that generate different connected and/or nested spans — all of which have trace data encoded in them. This data can include recorded annotation information like date, time, duration, error messages, service names or any metadata. +Multiple functions are performed on the request that generate different connected and/or nested spans - all of which have trace data encoded in them. This data can include recorded annotation information like date, time, duration, error messages, service names or any metadata. This trace data, logs and signal information provides a metric enabling developers to not only debug current systems, but to optimize their code for future service enhancement. diff --git a/docs/Monitor-your-data/OpenTelemetry/getting-started.md b/docs/Monitor-your-data/OpenTelemetry/getting-started.md index a34a6cd..6c110e4 100644 --- a/docs/Monitor-your-data/OpenTelemetry/getting-started.md +++ b/docs/Monitor-your-data/OpenTelemetry/getting-started.md @@ -2,7 +2,7 @@ ## What is OpenTelemetry? -OpenTelemetry (OTel) is an industry-standard, open-source observability framework designed to create and manage telemetry data—**Metrics, Traces, and Logs**. It provides a unified set of APIs and libraries that allow you to instrument your applications once and send the data to any backend, such as FusionReactor Cloud. +OpenTelemetry (OTel) is an industry-standard, open-source observability framework designed to create and manage telemetry data-**Metrics, Traces, and Logs**. It provides a unified set of APIs and libraries that allow you to instrument your applications once and send the data to any backend, such as FusionReactor Cloud. By adopting OpenTelemetry, you avoid vendor lock-in and gain deep visibility into the performance and health of your distributed systems. diff --git a/mkdocs.yml b/mkdocs.yml index 685992d..f37c101 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -207,302 +207,289 @@ nav: - Install MCP: Monitor-your-data/Katie/install.md - FEATURES: - Overview: Data-insights/Features/overview.md - # - Data-insights/Features/account.md - - Alerts & Anomaly Detection: - - Alerts: - - Overview: Data-insights/Features/Alerting/Alerts-overview.md - - Rules: Data-insights/Features/Alerting/Alert-Rules/Configure-rules.md - - Contact Points: - - Overview: Data-insights/Features/Alerting/Contact-points.md - - Notification Templates: Data-insights/Features/Alerting/Templates.md - - Notification Policy: - - Overview: Data-insights/Features/Alerting/Notifications.md - - Time intervals: Data-insights/Features/Alerting/Mute-timings.md - - Silences: Data-insights/Features/Alerting/Silences.md - - Firing Alerts: Data-insights/Features/Alerting/Active-alerts.md - - Examples: Data-insights/Features/alerting-examples.md - - Troubleshooting: Data-insights/Features/Alerting/Troubleshooting.md - - FAQ: Data-insights/Features/Alerting/FAQ.md + - Servers: Data-insights/Features/Explore-servers.md + - Applications: Data-insights/Features/applications.md + - Database: Data-insights/Features/database.md + - Dashboards: Data-insights/Features/dashboards.md + - Explore: Data-insights/Features/explore.md + - Metrics Drilldown: Data-insights/Features/explore-metrics.md + - Logs Drilldown: Data-insights/Features/explore-logs.md + - Traces Drilldown: Data-insights/Features/explore-traces.md + - Alerts: + - Overview: Data-insights/Features/Alerting/Alerts-overview.md + - Examples: + - Overview: Data-insights/Features/alerting-examples.md + - FR Agent metrics: Data-insights/Features/FR-Agent-Metrics.md - Anomaly Detection: - Overview: Data-insights/Features/Anomaly-Detection/ADoverview.md - User guide: Data-insights/Features/Anomaly-Detection/ADuserguide.md - - Applications: Data-insights/Features/applications.md - - CPU Sampler: - - Data-insights/Features/CPU-Sampler/CPU-Sampler.md - - Settings: Data-insights/Features/CPU-Sampler/CPU-Sampler-Settings.md - - Crash Protection: - - Overview: Data-insights/Features/Crash-protection/Crash-Protection.md - - Events: Data-insights/Features/Crash-protection/Events.md - - Settings: Data-insights/Features/Crash-protection/Settings.md - - Dashboards: Data-insights/Features/dashboards.md - - Debugger: - - Data-insights/Features/Debugger/Overview.md - - Data-insights/Features/Debugger/Breakpoints.md - - Data-insights/Features/Debugger/Debug-Email-Alert.md - - Data-insights/Features/Debugger//Event-Snapshot.md - - Data-insights/Features/Debugger/Security.md - - Data-insights/Features/Debugger/Settings.md - - Data-insights/Features/Debugger/Sources.md - - Deep: - - Overview: Monitor-your-data/Deep/overview.md - - Features: - - Search: Data-insights/Features/Deep/Search.md - - Tracepoints: Data-insights/Features/Deep/Create-Tracepoint.md - - Enterprise Dashboard: - - Overview: Data-insights/Features/Enterprise-Dashboard/Enterprise-Dashboard.md - - Settings: Data-insights/Features/Enterprise-Dashboard/Settings.md - - Enterprise scripting: - - Overview: Data-insights/Features/Enterprise-Dashboard/Enterprise-Scripting.md - - Scripting example: Data-insights/Features/Enterprise-Dashboard/Enterprise-Scripting-Example.md - - Monitored server scripts: Data-insights/Features/Enterprise-Dashboard/Using-Monitored-Server-Scripts.md - - Explore: - - Overview: Data-insights/Features/explore.md - - Metrics: Data-insights/Features/explore-metrics.md - - Logs: Data-insights/Features/explore-logs.md - - Traces: Data-insights/Features/explore-traces.md - - Servers: Data-insights/Features/Explore-servers.md - - Applications: Data-insights/Features/new-applications.md - - Historic data: Data-insights/Features/timepicker.md - - Incidents: + - Rules: Data-insights/Features/Alerting/Alert-Rules/Configure-rules.md + - Contact Points: + - Overview: Data-insights/Features/Alerting/Contact-points.md + - Notification Templates: Data-insights/Features/Alerting/Templates.md + - Notification Policy: + - Overview: Data-insights/Features/Alerting/Notifications.md + - Time intervals: Data-insights/Features/Alerting/Mute-timings.md + - Silences: Data-insights/Features/Alerting/Silences.md + - Firing Alerts: Data-insights/Features/Alerting/Active-alerts.md + - Troubleshooting: Data-insights/Features/Alerting/Troubleshooting.md + - FAQ: Data-insights/Features/Alerting/FAQ.md + - Incidents: - Overview: Data-insights/Features/Incidents/incidents.md - Settings: Data-insights/Features/Incidents/Settings.md - - JDBC: - - Data-insights/Features/JDBC/Databases.md - - Data-insights/Features/JDBC/JDBC-Activity-Graph.md - - Data-insights/Features/JDBC/JDBC-Activity.md - - Data-insights/Features/JDBC/JDBC-By-Mem.md - - Data-insights/Features/JDBC/JDBC-Error-History.md - - Data-insights/Features/JDBC/JDBC-Event-Snapshot-History.md - - Data-insights/Features/JDBC/JDBC-History.md - - Data-insights/Features/JDBC/JDBC-Monitoring.md - - Data-insights/Features/JDBC/JDBC-Time-Graph.md - - Data-insights/Features/JDBC/Long-JDBC.md - - Data-insights/Features/JDBC/Settings.md - - Data-insights/Features/JDBC/Slow-JDBC.md - - Logs: - - Overview: Data-insights/Features/Logs/Logs.md - - Data-insights/Features/Logs/Importing-and-Graphing-Data-in-Excel.md - - Log Archives: - - Overview: Data-insights/Features/Logs/Log-Archives.md - - Data-insights/Features/Logs/Log-Archive-Viewer.md - - Data-insights/Features/Logs/Settings.md - - Cloud: - - Data-insights/Features/Logs/Cloud-Settings.md - - Data-insights/Features/Logs/Cloud-Log-Obfuscation-Rules.md - - Data-insights/Features/Logs/Cloud-Log-MultiLine-Blocks.md - - Files: - - Data-insights/Features/Logs/Memory-Logs.md - - Data-insights/Features/Logs/Files/Class-Loading-Log.md - - Data-insights/Features/Logs/Files/Cloud-State-Log.md - - Data-insights/Features/Logs/Files/CPU-Thread-Log.md - - Data-insights/Features/Logs/Files/Crash-Protection-Log.md - - Data-insights/Features/Logs/Files/Device-Log.md - - Data-insights/Features/Logs/Files/Garbage-Collection-Logs.md - - Data-insights/Features/Logs/Files/Instance-Manager-Log.md - - Data-insights/Features/Logs/Files/JDBC-Log.md - - Data-insights/Features/Logs/Files/Notification-Log.md - - Data-insights/Features/Logs/Files/Reactor-Log.md - - Data-insights/Features/Logs/Files/Request-Log.md - - Data-insights/Features/Logs/Files/Resource-Log.md - - Data-insights/Features/Logs/Files/Stdout.log-and-Stderr.log.md - - Data-insights/Features/Logs/Files/Thread-State-Log.md - - Memory: - - Data-insights/Features/Memory/Overview.md - - Data-insights/Features/Memory/Settings.md - - Metrics: - - Overview: Data-insights/Features/Metrics/Metrics-Page.md - - Archive Metrics: Data-insights/Features/Metrics/Archive-Metrics.md - - AWS: - - CloudWatch Metrics: Data-insights/Features/Metrics/AWS-CloudWatch-Metrics.md - - Configuration: Data-insights/Features/Metrics/AWS-CloudMetrics-Configuration.md - - ColdFusion: - - Metrics: Data-insights/Features/Metrics/ColdFusion-Metrics.md - - System Metrics: Data-insights/Features/Metrics/ColdFusion-System-Metrics.md - - Custom Metrics: Data-insights/Features/Metrics/Custom-Metrics.md - - JMX-MBeans: Data-insights/Features/Metrics/JMX-MBeans.md - - Kafka: Data-insights/Features/Metrics/Kafka-Metrics.md - #- Metrics/Kafka-Node-Metrics.md - - Web Metrics: Data-insights/Features/Metrics/Web-Metrics.md - - OpsPilot: - - OpsPilot Assistant: + - Knowledge: Data-insights/Features/OpsPilot/OpsPilot-Hub/Knowledge.md + - OpsPilot Assistant: - Overview: Data-insights/Features/OpsPilot/AIoverview.md - - OpsPilot Integrations: - - Overview: Data-insights/Features/OpsPilot/OpsPilot-Hub/integrations-overview.md - - OpsPilot Hub: - - Overview: Data-insights/Features/OpsPilot/OpsPilot-Hub/overview.md - - Assistant: - - User guide: Data-insights/Features/OpsPilot/OpsPilot-user-guide.md - - Services: Data-insights/Features/OpsPilot/OpsPilot-Hub/Services.md - - Knowledge: Data-insights/Features/OpsPilot/OpsPilot-Hub/Knowledge.md - - Integrations: - - Jira: Data-insights/Features/OpsPilot/OpsPilot-Hub/Jira.md - - Microsoft Teams: Data-insights/Features/OpsPilot/OpsPilot-Hub/Teams.md - - Slack: Data-insights/Features/OpsPilot/OpsPilot-Hub/Slack.md - - Profiler: - - Data-insights/Features/Profiler/Profiler.md - - Settings: Data-insights/Features/Profiler/Profiler-Settings.md - - Pyroscope: Data-insights/Features/Pyroscope/pyroscope.md - - Requests: - - Data-insights/Features/Requests/Applications.md - - Data-insights/Features/Requests/Compression.md - - Data-insights/Features/Requests/Content-Filters.md - - Data-insights/Features/Requests/Long-Requests.md - - Data-insights/Features/Requests/Req-By-Mem.md - - Data-insights/Features/Requests/Request-Activity.md - - Data-insights/Features/Requests/Request-Details.md - - Data-insights/Features/Requests/Request-Error-History.md - - Data-insights/Features/Requests/Request-Event-Snapshot-History.md - - Data-insights/Features/Requests/Request-History.md - - Data-insights/Features/Requests/Request-Time-Graph.md - - Data-insights/Features/Requests/Response-Codes.md - - Data-insights/Features/Requests/Settings.md - - Data-insights/Features/Requests/Slow-Requests.md - - Resources: - - Data-insights/Features/Resources/Buffer-Pool.md - - Data-insights/Features/Resources/Classes.md - - Data-insights/Features/Resources/Class-Loading.md - - Data-insights/Features/Resources/CPU-Graph.md - - Data-insights/Features/Resources/Garbage-Collection.md - - Data-insights/Features/Resources/Heap-Non-Heap-Memory.md - - Data-insights/Features/Resources/JIT-Time.md - - Data-insights/Features/Resources/Memory-Heap.md - - Data-insights/Features/Resources/Memory-Spaces.md - - Data-insights/Features/Resources/Settings.md - - Data-insights/Features/Resources/Thread-Activity.md - - Data-insights/Features/Resources/Threads.md - - Data-insights/Features/Resources/Thread-State.md - - Data-insights/Features/Resources/Thread-Visualizer.md - - Servers: Data-insights/Features/servers.md - - Settings: - - Data-insights/Features/Settings/CPU-Sampler.md - - Data-insights/Features/Settings/Debugger.md - - Enterprise Dashboard: Data-insights/Features/Enterprise-Dashboard/Settings/ - - Data-insights/Features/Settings/Filter-Restrictions.md - - Data-insights/Features/Settings/JDBC.md - - Data-insights/Features/Settings/Logging.md - - Data-insights/Features/Settings/Logging-Cloud.md - - Data-insights/Features/Settings/Main-Menu.md - - Data-insights/Features/Settings/Memory.md - - Data-insights/Features/Settings/Profiler.md - - Data-insights/Features/Settings/Protection.md - - Requests: Data-insights/Features/Settings/Requests.md - - Data-insights/Features/Settings/Resources.md - - Data-insights/Features/Settings/System-Resources.md - - Data-insights/Features/Settings/UEM-Sessions.md - - System Resources: - - Data-insights/Features/System-Resources/CPU.md - - Data-insights/Features/System-Resources/Disk.md - - Data-insights/Features/System-Resources/Network-Usage.md - - Data-insights/Features/System-Resources/Process-Details.md - - Data-insights/Features/System-Resources/Processes.md - - Data-insights/Features/System-Resources/Server-Info.md - - Data-insights/Features/System-Resources/Settings.md - - Data-insights/Features/System-Resources/System-Memory.md - - Data-insights/Features/System-Resources/System-Metrics.md - - Transactions: - - Data-insights/Features/Transactions/Activity.md - - Data-insights/Features/Transactions/Activity-Graph.md - - Data-insights/Features/Transactions/Error-History.md - - Data-insights/Features/Transactions/Event-Snapshot-History.md - - Data-insights/Features/Transactions/External-Sources.md - - Data-insights/Features/Transactions/Longest-Transactions.md - - Data-insights/Features/Transactions/Middleware-Sources.md - - Data-insights/Features/Transactions/MongoDB-Transactions.md - - Data-insights/Features/Transactions/Slow-Transactions.md - - Data-insights/Features/Transactions/Stack-Tracing.md - - Data-insights/Features/Transactions/SubFlavors.md - - Data-insights/Features/Transactions/Time-Graph.md - - Transaction History: Data-insights/Features/Transactions/History.md - - Data-insights/Features/Transactions/Transaction-Naming.md - - Data-insights/Features/Transactions/Transaction-Settings.md - - Data-insights/Features/Transactions/Transactions.md - - Data-insights/Features/Transactions/Trans.-By-Mem.md - - Data-insights/Features/Transactions/Transit.md - - UEM Sessions: - - Overview: Data-insights/Features/UEM/User-Experience-Monitoring.md - - Sessions: Data-insights/Features/UEM/Sessions.md - - Data-insights/Features/UEM/Settings.md - - FAQs & troubleshooting: - - Cloud: - - Troubleshooting/logging-regex-pattern-hints.md - - Troubleshooting cloud connections: Troubleshooting/trouble.md - - Troubleshooting/Cloud-historical-data.md - - Troubleshooting/Optimize-data.md - - Troubleshooting/Cloud-span-name.md - - Troubleshooting/Cloud-find-slow-pages.md - - Troubleshooting/Cloud-offline.md - - Troubleshooting/cloud-storing-logs.md - - FusionReactor Cloud Has Moved: Troubleshooting/Cloud-has-moved.md - - On-Premise: - - Troubleshooting/Known-Issues/Web-Sockets-In-WildFly.md #onprem - - Troubleshooting/Resetting-Instance-Password.md #onprem - - Troubleshooting/Server-is-suffering-from-Clock-Drift.md #onprem - - Troubleshooting/OnPrem-Exception-Support.md - - Troubleshooting/Configuration/Application-Naming-Configuration.md - - Troubleshooting/Configuration/Automatic-FusionReactor-Login.md - - Troubleshooting/Configuration/Copying-FusionReactor-Configuration-Between_Instances.md - - Troubleshooting/Configuration/Email-Configuration.md - - Troubleshooting/Configuration/Enabling-and-Disabling-FusionReactor-functions.md - - Troubleshooting/Configuration/Enterprise-Dashboard-Configuration.md - - Troubleshooting/Configuration/Transaction-Naming-Configuration.md - - Troubleshooting/Configuration/Using-FusionReactor-via-external-web-server.md - - Troubleshooting/OP-historical-data.md - - Troubleshooting/OP-deadlocks.md - - Troubleshooting/OP-offline-server.md - - Troubleshooting/storing-fr-logs.md - - Troubleshooting/OP-setting-up-reports.md - - Extras: - - FRAPI: Data-insights/Extras/FRAPI.md - - Distributed tracing: - - Monitor-your-data/FR-Agent/More/Distributed-Tracing/attributes.md - - Monitor-your-data/FR-Agent/More/Distributed-Tracing/propagators.md - - Monitor-your-data/FR-Agent/More/Distributed-Tracing/sampling.md - - Monitor-your-data/FR-Agent/More/Distributed-Tracing/exporting.md - - Monitor-your-data/FR-Agent/More/Distributed-Tracing/span-lifecycle.md - - Monitor-your-data/FR-Agent/More/Distributed-Tracing/linkage-in-grafana.md - - Plugins: - - Data-insights/Extras/Plugins/Overview.md - - Data-insights/Extras/Plugins/FusionReactor-AMF-Dissector-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-ColdFusion-Line-Performance-Profiler.md - - Data-insights/Extras/Plugins/FusionReactor-ColdFusion-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-Deadlock-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-Heartbeat-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-HitCount-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-JRun-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-Json-Data-Tracker-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-Log-Rotator-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-Log-Tracker-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-Lucee-and-Railo-Line-Performance-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-Notification-Generator-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-Production-Debugger-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-Reports-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-System-Monitor-Plugin.md - - Data-insights/Extras/Plugins/FusionReactor-Transaction-Logger-Plugin.md - - ADMIN & DATA: - - Account & member management: - - Cloud: - - Account: - - Organization: Admin-and-data/Account/Cloud/users.md - - Roles: Admin-and-data/Account/Cloud/roles.md - - Profile Settings: - - Profile: Admin-and-data/Account/Cloud/profile.md - - Security: Admin-and-data/Account/Cloud/security.md - - On-Premise: Admin-and-data/Account/On-Premise/OPusers.md + - User guide: Data-insights/Features/OpsPilot/OpsPilot-user-guide.md + - FusionReactor Agent UI: + - CPU Sampler: + - Data-insights/Features/CPU-Sampler/CPU-Sampler.md + - Settings: Data-insights/Features/CPU-Sampler/CPU-Sampler-Settings.md + - Crash Protection: + - Overview: Data-insights/Features/Crash-protection/Crash-Protection.md + - Events: Data-insights/Features/Crash-protection/Events.md + - Settings: Data-insights/Features/Crash-protection/Settings.md + - Debugger: + - Data-insights/Features/Debugger/Overview.md + - Data-insights/Features/Debugger/Breakpoints.md + - Data-insights/Features/Debugger/Debug-Email-Alert.md + - Data-insights/Features/Debugger/Event-Snapshot.md + - Data-insights/Features/Debugger/Security.md + - Data-insights/Features/Debugger/Settings.md + - Data-insights/Features/Debugger/Sources.md + - Deep: + - Overview: Monitor-your-data/Deep/overview.md + - Features: + - Search: Data-insights/Features/Deep/Search.md + - Tracepoints: Data-insights/Features/Deep/Create-Tracepoint.md + - Enterprise Dashboard: + - Overview: Data-insights/Features/Enterprise-Dashboard/Enterprise-Dashboard.md + - Settings: Data-insights/Features/Enterprise-Dashboard/Settings.md + - Enterprise scripting: + - Overview: Data-insights/Features/Enterprise-Dashboard/Enterprise-Scripting.md + - Scripting example: Data-insights/Features/Enterprise-Dashboard/Enterprise-Scripting-Example.md + - Monitored server scripts: Data-insights/Features/Enterprise-Dashboard/Using-Monitored-Server-Scripts.md + - Extras: + - FRAPI: Data-insights/Extras/FRAPI.md + - Distributed tracing: + - Monitor-your-data/FR-Agent/More/Distributed-Tracing/attributes.md + - Monitor-your-data/FR-Agent/More/Distributed-Tracing/propagators.md + - Monitor-your-data/FR-Agent/More/Distributed-Tracing/sampling.md + - Monitor-your-data/FR-Agent/More/Distributed-Tracing/exporting.md + - Monitor-your-data/FR-Agent/More/Distributed-Tracing/span-lifecycle.md + - Monitor-your-data/FR-Agent/More/Distributed-Tracing/linkage-in-grafana.md + - Plugins: + - Data-insights/Extras/Plugins/Overview.md + - Data-insights/Extras/Plugins/FusionReactor-AMF-Dissector-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-ColdFusion-Line-Performance-Profiler.md + - Data-insights/Extras/Plugins/FusionReactor-ColdFusion-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-Deadlock-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-Heartbeat-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-HitCount-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-JRun-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-Json-Data-Tracker-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-Log-Rotator-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-Log-Tracker-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-Lucee-and-Railo-Line-Performance-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-Notification-Generator-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-Production-Debugger-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-Reports-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-System-Monitor-Plugin.md + - Data-insights/Extras/Plugins/FusionReactor-Transaction-Logger-Plugin.md + - FAQs & troubleshooting: + - Cloud: + - Troubleshooting/logging-regex-pattern-hints.md + - Troubleshooting cloud connections: Troubleshooting/trouble.md + - Troubleshooting/Cloud-historical-data.md + - Troubleshooting/Optimize-data.md + - Troubleshooting/Cloud-span-name.md + - Troubleshooting/Cloud-find-slow-pages.md + - Troubleshooting/Cloud-offline.md + - Troubleshooting/cloud-storing-logs.md + - FusionReactor Cloud Has Moved: Troubleshooting/Cloud-has-moved.md + - On-Premise: + - Troubleshooting/Known-Issues/Web-Sockets-In-WildFly.md #onprem + - Troubleshooting/Resetting-Instance-Password.md #onprem + - Troubleshooting/Server-is-suffering-from-Clock-Drift.md #onprem + - Troubleshooting/OnPrem-Exception-Support.md + - Troubleshooting/Configuration/Application-Naming-Configuration.md + - Troubleshooting/Configuration/Automatic-FusionReactor-Login.md + - Troubleshooting/Configuration/Copying-FusionReactor-Configuration-Between_Instances.md + - Troubleshooting/Configuration/Email-Configuration.md + - Troubleshooting/Configuration/Enabling-and-Disabling-FusionReactor-functions.md + - Troubleshooting/Configuration/Enterprise-Dashboard-Configuration.md + - Troubleshooting/Configuration/Transaction-Naming-Configuration.md + - Troubleshooting/Configuration/Using-FusionReactor-via-external-web-server.md + - Troubleshooting/OP-historical-data.md + - Troubleshooting/OP-deadlocks.md + - Troubleshooting/OP-offline-server.md + - Troubleshooting/storing-fr-logs.md + - Troubleshooting/OP-setting-up-reports.md + - Historic data: Data-insights/Features/timepicker.md + - JDBC: + - Data-insights/Features/JDBC/Databases.md + - Data-insights/Features/JDBC/JDBC-Activity-Graph.md + - Data-insights/Features/JDBC/JDBC-Activity.md + - Data-insights/Features/JDBC/JDBC-By-Mem.md + - Data-insights/Features/JDBC/JDBC-Error-History.md + - Data-insights/Features/JDBC/JDBC-Event-Snapshot-History.md + - Data-insights/Features/JDBC/JDBC-History.md + - Data-insights/Features/JDBC/JDBC-Monitoring.md + - Data-insights/Features/JDBC/JDBC-Time-Graph.md + - Data-insights/Features/JDBC/Long-JDBC.md + - Data-insights/Features/JDBC/Settings.md + - Data-insights/Features/JDBC/Slow-JDBC.md + - Logs: + - Overview: Data-insights/Features/Logs/Logs.md + - Data-insights/Features/Logs/Importing-and-Graphing-Data-in-Excel.md + - Log Archives: + - Overview: Data-insights/Features/Logs/Log-Archives.md + - Data-insights/Features/Logs/Log-Archive-Viewer.md + - Data-insights/Features/Logs/Settings.md + - Cloud: + - Data-insights/Features/Logs/Cloud-Settings.md + - Data-insights/Features/Logs/Cloud-Log-Obfuscation-Rules.md + - Data-insights/Features/Logs/Cloud-Log-MultiLine-Blocks.md + - Files: + - Data-insights/Features/Logs/Memory-Logs.md + - Data-insights/Features/Logs/Files/Class-Loading-Log.md + - Data-insights/Features/Logs/Files/Cloud-State-Log.md + - Data-insights/Features/Logs/Files/CPU-Thread-Log.md + - Data-insights/Features/Logs/Files/Crash-Protection-Log.md + - Data-insights/Features/Logs/Files/Device-Log.md + - Data-insights/Features/Logs/Files/Garbage-Collection-Logs.md + - Data-insights/Features/Logs/Files/Instance-Manager-Log.md + - Data-insights/Features/Logs/Files/JDBC-Log.md + - Data-insights/Features/Logs/Files/Notification-Log.md + - Data-insights/Features/Logs/Files/Reactor-Log.md + - Data-insights/Features/Logs/Files/Request-Log.md + - Data-insights/Features/Logs/Files/Resource-Log.md + - Data-insights/Features/Logs/Files/Stdout.log-and-Stderr.log.md + - Data-insights/Features/Logs/Files/Thread-State-Log.md + - Memory: + - Data-insights/Features/Memory/Overview.md + - Data-insights/Features/Memory/Settings.md + - Metrics: + - Overview: Data-insights/Features/Metrics/Metrics-Page.md + - Archive Metrics: Data-insights/Features/Metrics/Archive-Metrics.md + - AWS: + - CloudWatch Metrics: Data-insights/Features/Metrics/AWS-CloudWatch-Metrics.md + - Configuration: Data-insights/Features/Metrics/AWS-CloudMetrics-Configuration.md + - ColdFusion: + - Metrics: Data-insights/Features/Metrics/ColdFusion-Metrics.md + - System Metrics: Data-insights/Features/Metrics/ColdFusion-System-Metrics.md + - Custom Metrics: Data-insights/Features/Metrics/Custom-Metrics.md + - JMX-MBeans: Data-insights/Features/Metrics/JMX-MBeans.md + - Kafka: Data-insights/Features/Metrics/Kafka-Metrics.md + #- Metrics/Kafka-Node-Metrics.md + - Web Metrics: Data-insights/Features/Metrics/Web-Metrics.md + - Profiler: + - Data-insights/Features/Profiler/Profiler.md + - Settings: Data-insights/Features/Profiler/Profiler-Settings.md + - Pyroscope: Data-insights/Features/Pyroscope/pyroscope.md + - Requests: + - Data-insights/Features/Requests/Applications.md + - Data-insights/Features/Requests/Compression.md + - Data-insights/Features/Requests/Content-Filters.md + - Data-insights/Features/Requests/Long-Requests.md + - Data-insights/Features/Requests/Req-By-Mem.md + - Data-insights/Features/Requests/Request-Activity.md + - Data-insights/Features/Requests/Request-Details.md + - Data-insights/Features/Requests/Request-Error-History.md + - Data-insights/Features/Requests/Request-Event-Snapshot-History.md + - Data-insights/Features/Requests/Request-History.md + - Data-insights/Features/Requests/Request-Time-Graph.md + - Data-insights/Features/Requests/Response-Codes.md + - Data-insights/Features/Requests/Settings.md + - Data-insights/Features/Requests/Slow-Requests.md + - Resources: + - Data-insights/Features/Resources/Buffer-Pool.md + - Data-insights/Features/Resources/Classes.md + - Data-insights/Features/Resources/Class-Loading.md + - Data-insights/Features/Resources/CPU-Graph.md + - Data-insights/Features/Resources/Garbage-Collection.md + - Data-insights/Features/Resources/Heap-Non-Heap-Memory.md + - Data-insights/Features/Resources/JIT-Time.md + - Data-insights/Features/Resources/Memory-Heap.md + - Data-insights/Features/Resources/Memory-Spaces.md + - Data-insights/Features/Resources/Settings.md + - Data-insights/Features/Resources/Thread-Activity.md + - Data-insights/Features/Resources/Threads.md + - Data-insights/Features/Resources/Thread-State.md + - Data-insights/Features/Resources/Thread-Visualizer.md + - Settings: + - Data-insights/Features/Settings/CPU-Sampler.md + - Data-insights/Features/Settings/Debugger.md + - Enterprise Dashboard: Data-insights/Features/Enterprise-Dashboard/Settings/ + - Data-insights/Features/Settings/Filter-Restrictions.md + - Data-insights/Features/Settings/JDBC.md + - Data-insights/Features/Settings/Logging.md + - Data-insights/Features/Settings/Logging-Cloud.md + - Data-insights/Features/Settings/Main-Menu.md + - Data-insights/Features/Settings/Memory.md + - Data-insights/Features/Settings/Profiler.md + - Data-insights/Features/Settings/Protection.md + - Requests: Data-insights/Features/Settings/Requests.md + - Data-insights/Features/Settings/Resources.md + - Data-insights/Features/Settings/System-Resources.md + - Data-insights/Features/Settings/UEM-Sessions.md + - System Resources: + - Data-insights/Features/System-Resources/CPU.md + - Data-insights/Features/System-Resources/Disk.md + - Data-insights/Features/System-Resources/Network-Usage.md + - Data-insights/Features/System-Resources/Process-Details.md + - Data-insights/Features/System-Resources/Processes.md + - Data-insights/Features/System-Resources/Server-Info.md + - Data-insights/Features/System-Resources/Settings.md + - Data-insights/Features/System-Resources/System-Memory.md + - Data-insights/Features/System-Resources/System-Metrics.md + - Transactions: + - Data-insights/Features/Transactions/Activity.md + - Data-insights/Features/Transactions/Activity-Graph.md + - Data-insights/Features/Transactions/Error-History.md + - Data-insights/Features/Transactions/Event-Snapshot-History.md + - Data-insights/Features/Transactions/External-Sources.md + - Data-insights/Features/Transactions/Longest-Transactions.md + - Data-insights/Features/Transactions/Middleware-Sources.md + - Data-insights/Features/Transactions/MongoDB-Transactions.md + - Data-insights/Features/Transactions/Slow-Transactions.md + - Data-insights/Features/Transactions/Stack-Tracing.md + - Data-insights/Features/Transactions/SubFlavors.md + - Data-insights/Features/Transactions/Time-Graph.md + - Transaction History: Data-insights/Features/Transactions/History.md + - Data-insights/Features/Transactions/Transaction-Naming.md + - Data-insights/Features/Transactions/Transaction-Settings.md + - Data-insights/Features/Transactions/Transactions.md + - Data-insights/Features/Transactions/Trans.-By-Mem.md + - Data-insights/Features/Transactions/Transit.md + - UEM Sessions: + - Overview: Data-insights/Features/UEM/User-Experience-Monitoring.md + - Sessions: Data-insights/Features/UEM/Sessions.md + - Data-insights/Features/UEM/Settings.md + - ADMINISTRATION: + - Usage & Details: Admin-and-data/usage-and-details.md - Billing: - Cloud: Admin-and-data/Billing/Cloud/overview.md - On-Premise: - Overview: Admin-and-data/Billing/On-Premise/billing.md - Licenses: Admin-and-data/Billing/On-Premise/licenses.md - - Data limits: Admin-and-data/Limits.md - - Licensing: + - Invoices: Admin-and-data/invoices.md + - Licenses: - Overview: Admin-and-data/Licensing/Licensing.md - Manual activation: Admin-and-data/Licensing/Manual-Activation.md - Static endpoints: Admin-and-data/Licensing/Static-Licensing-Endpoints.md - Troubleshooting: Admin-and-data/Licensing/Troubleshooting.md - EULA: Admin-and-data/EULA.md + - API Keys: Admin-and-data/api-keys.md + - Organization Settings: Admin-and-data/organization-settings.md + - Organization Users: Admin-and-data/Account/Cloud/users.md + - User Profile: Admin-and-data/Account/Cloud/profile.md + - User Security: Admin-and-data/Account/Cloud/security.md + - Data limits: Admin-and-data/Limits.md + - On-Premise users: Admin-and-data/Account/On-Premise/OPusers.md - Security: Admin-and-data/security.md - Terms of Service: Admin-and-data/tos.md - - Third Party Licenses: + - Third Party Licenses: - Cloud: Admin-and-data/Third-Party-Licenses/licenses.md - On-Premise: Admin-and-data/Third-Party-Licenses/Third_Party_License_Agreements.md - HOW TO CONTRIBUTE: @@ -510,7 +497,7 @@ nav: - Style Guide: - Overview: Contribute/style-guide/overview.md - Images: Contribute/style-guide/images.md - - Language & grammar: + - Language & grammar: - Abbreviations: Contribute/style-guide/Language-and-grammar/Abbreviations.md - Capitalization: Contribute/style-guide/Language-and-grammar/Capitalization.md - Contractions: Contribute/style-guide/Language-and-grammar/Contractions.md