diff --git a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Jira.md b/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Jira.md deleted file mode 100644 index fe70ca2..0000000 --- a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Jira.md +++ /dev/null @@ -1,189 +0,0 @@ -
- -OpsPilot's Jira integration enables seamless ticket management and tracking directly through the OpsPilot interface. This integration supports both Atlassian Cloud and Data Center deployments. - - - -!!! info - Single project integration per connection. - - -## Setting up the integration - -### Prerequisites -- A valid Jira account with administrative access. -- For Cloud installations: Access to Atlassian Cloud administration. -- For Data Center installations: Your Jira instance URL and access token. - -### Installation methods - -There are two ways to add the Jira integration: - -**Available Integrations Tab** - -- Navigate to the **Integrations** page. -- Select the **Available** tab. -- Locate and click on the **Jira** integration. -- Follow the connection dialog prompts. - -**Quick Add** - -- Click the integration **Quick-add** button in the top right. -- Select **Jira** from the available options. -- Follow the connection dialog prompts. - -### Connection types - - - Jira Cloud: Best for organizations using Jira through Atlassian's cloud platform. - -- Jira Data Center: Best for self-hosted Jira instances or organizations requiring complete control over their Jira deployment. - - -## Jira Cloud installation - -Jira Cloud integration requires downloading our app from the [Atlassian Marketplace](https://marketplace.atlassian.com/vendors/1227151/) - - - -### Add Jira integration: - -1. Click the Install button on the **OpsPilot Hub** page, or install from the Jira marketplace. -2. If prompted, select your Jira instance. -3. Review and accept the app permissions. -4. Wait for the installation to complete. -5. Click the **Configure** button on the OpsPilot Jira application. -6. On the configuration page, click the **Connect** button and follow any further prompts. -7. The following screen is displayed after once installation is complete: - - - - -After successfully connecting the Jira integration, the configuration screen is displayed: - - - -!!! note - An account can be disconnected at any time. Upon disconnection, OpsPilot immediately loses access to Jira features for that specific account. - -## Jira Data Centre installation - - -To integrate OpsPilot with your Jira Data Center instance, you'll need: - -* A publicly accessible Jira server URL -* A Personal Access Token (PAT) - - - - - -!!! tip - Create a dedicated Jira service account (e.g. OpsPilot) for the integration rather than using personal accounts. This ensures clear tracking of OpsPilot-generated content, maintains consistent permissions, and provides integration stability independent of staff changes. - - -### Create an access token - -1. Log in to Jira as an administrator. -2. Go to **User Management** > **Users**. -3. Click **Create User** and enter the following details: - - Username: OpsPilot - - Email: [Enter email] - !!! note - Enter any valid email format - this field is not validated against actual email addresses. - - - Password: [Set secure password] - -4. Assign admin permissions: - - Navigate to the **Groups** tab. - - Add OpsPilot to the **jira-administrators** group. - -5. Create Personal Access Token: - - Log in as OpsPilot. - - Navigate to **Profile** > **Personal Access Tokens**. - - Click **Create token**. - - Name the token and set no expiry. - - Copy the generated token. - -!!! info - A customer can connect the same Jira instance to multiple different FusionReactor/OpsPilot accounts. - - -## Managing your integration - -### Project selection & permissions -After connecting Jira, configure your integration by selecting a project: - -1. Navigate to OpsPilot Hub. -2. Open the Jira integration settings. -3. Choose a project from the dropdown menu. - -!!! info - All configuration changes require saving through the **Update JIRA** button to take effect. - -The selected project can be changed at any time from the Jira integration page in OpsPilot Hub. - - - -When a project is selected, OpsPilot can: - -- Look up existing issues -- Create new issues -- Add comments to issues -- Search within project content - - - - - -!!! Note - A project must be selected after connecting Jira for the integration to function. Without project selection, OpsPilot cannot perform any Jira-related actions. - - -### Creating tickets - -1. OpsPilot automatically checks for similar existing tickets. -2. Preview form provides editing capabilities for: - - Title - - Description - - Priority - - -#### Supported issue types -- Tasks -- Bugs -- New features -- Epics - -!!! info - OpsPilot can automatically determine the appropriate issue type based on ticket content if not specified. - -#### Custom fields support - -OpsPilot supports various custom fields including: - -- Labels -- Fixed versions -- Custom project-specific fields - -!!! Tip - OpsPilot can be trained through your knowledge base to handle custom fields according to your organization's preferences. - -#### Comment management - -- Add comments to existing tickets -- Automatic ticket linking -- Interactive clarification for ambiguous ticket references - - -#### Search capabilities -Search tickets by: - -- Creator -- Time period -- Topic relevance -- Specific ticket details - -#### Usage example - - - diff --git a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Services.md b/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Services.md deleted file mode 100644 index dc34217..0000000 --- a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Services.md +++ /dev/null @@ -1,46 +0,0 @@ -## Services - - - -The Services feature is a core component of OpsPilot Hub, designed to enhance the capabilities of the OpsPilot Assistant while providing a comprehensive system for documenting, managing, and discovering your organization's services. By populating the Services section with detailed information about your organization's offerings, you empower the OpsPilot Assistant to deliver more accurate, context-aware solutions and recommendations. - - - -### Service Page Features -- Progress bars for each service, indicating completeness of information. -- 100% completion when description, owner and knowledge are added. -- Ability to add non-FusionReactor services. -- Related knowledge sources visible below the service name when selected. -- Global progress indicator in top right (circular). -- Service filtering capability. - -### Service Discovery - -OpsPilot's service discovery process begins during initial customer provisioning, where the database is automatically populated with a list of the customer's services present at that time. However, if new services are added to the customer's infrastructure after this initial setup, OpsPilot won't automatically detect them and they will need to be manually added. - -For services that don't send metrics to FusionReactor, such as uninstrumented applications or third-party services, customers can use the manual addition feature. This allows you to add and maintain data for services that OpsPilot can't automatically detect, ensuring that your service list in OpsPilot provides a comprehensive view of your entire ecosystem, including both instrumented and non-instrumented services. - -!!! tip - To maintain an accurate and up-to-date service list, it's recommended that customers regularly use the **Discover Services** function, especially after known infrastructure changes. - - -### Service Information - - - -| Field | Description | -|-------|-------------| -| Description | Briefly explain what the service is and how it works. This field provides an overview of the service's purpose and functionality. | -| Tags | Add relevant tags for better organization and easier searching of services. | -| Service Metadata | Specify the individuals or teams responsible for the service. This information is useful for OpsPilot to suggest contacts for issue resolution. | -| Custom Metadata Categories | Add additional metadata fields as needed (e.g., programming language, deployment environment, version). These categories allow for more detailed service documentation. OpsPilot can use any metadata added. | - - -!!! tip - Every service entry should always include, at minimum, a description and an owner. For 100% completion, knowledge would also be required. - - - - - - \ No newline at end of file diff --git a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Slack.md b/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Slack.md deleted file mode 100644 index 5c99378..0000000 --- a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Slack.md +++ /dev/null @@ -1,96 +0,0 @@ -# Slack - - - -## Installation - - - - -1. In OpsPilot Hub, navigate to the Integrations tab. -2. Click **Add Integration** and select Slack from the available integrations. -3. Click the **Install** button, which will redirect you to Slack. -4. In Slack, you'll see a permissions window - review and click **Allow**. - - - - -5. Select your desired workspace if you have multiple workspaces. -6. Once allowed, OpsPilot will appear in your Slack sidebar. - -!!! info - If OpsPilot doesn't appear immediately in the sidebar, click **Add Apps** and find it in your installed apps. - -## Configuration - -1. Return to OpsPilot Hub after installation. -2. Click **Generate** to create an API key. -3. Copy the generated API key. -4. In Slack, navigate to the OpsPilot app. -5. Paste the API key and submit. -6. Your Slack workspace is now connected to OpsPilot. - - - - - - -!!! note - Only Slack administrators can enter the API key. Non-admin users will see a message prompting them to contact an admin for setup. - -## Features - -### Direct Messaging - -- Access OpsPilot directly through DMs. -- Send messages to get responses just like in the browser interface. -- Get visual confirmation of processing with eyeball indicators. -- Supports image uploads for vision-related queries. -- Graphs and visualizations are provided as static images. - -### Channel Integration - -- Use **@OpsPilot** in any channel where the app is present. -- OpsPilot reads the last 20 messages in the channel or thread for context. -- Threads are recommended for better context management. - -### Message Shortcuts - -To access shortcuts: - -1. Click the three dots menu on any message. -2. Click **More message shortcuts**, if shortcuts aren't visible. -3. Two options available: - - **Ask OpsPilot**: Gets a response in the channel for everyone to see. - - **Ask OpsPilot in DM**: Gets a private response about the message. - -## Limitations - -- Can only be installed to a single Slack workspace at a time. -- Shortcuts only work in channels where OpsPilot has access. -- Cannot access private messages or group chats unless explicitly invited. -- Responses are not streamed (must wait for complete response). -- Graphs are non-interactive (unlike browser version). - -## API Key Management - -- The API key is workspace-wide (one key for all users). -- Keys can be regenerated from the OpsPilot Hub. -- Regenerating invalidates the previous key. -- Requires admin to reconnect with new key if regenerated. - - - -## Best Practices - -1. Use threads for focused discussions to ensure relevant context. -2. For channel messages, be aware that OpsPilot only sees the last 20 messages. -3. Add OpsPilot to relevant channels where automated assistance is needed. -4. Use direct messages for private queries. -5. Utilize shortcuts for quick access to OpsPilot's features. - -## Visual Indicators - -- Eyeball emoji: OpsPilot is processing -- Tick emoji: Successful response -- Cross emoji: Error occurred diff --git a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Teams.md b/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Teams.md deleted file mode 100644 index 8e0778e..0000000 --- a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/Teams.md +++ /dev/null @@ -1,134 +0,0 @@ -# Microsoft Teams - -## Prerequisites -- Must be a Microsoft Teams administrator for your organization. -- Access to OpsPilot Hub. - - - - - - -## Installation - - - -### Step 1: **Download the Integration** - - - Access OpsPilot Hub Integrations section. - - Download the Teams integration ZIP file. - -### Step 2: **Add to Microsoft Teams** - - - Go to [Teams Admin Center](https://admin.teams.microsoft.com). - - Navigate to Teams apps → Manage apps. - - - - - Click Actions → Upload new app. - - - - - - Upload the OpsPilot ZIP file. - -### Step 3: **Configure Setup Policy** - - In Teams Admin Center, go to Teams apps → Setup policies. - - Edit Global policy or create new one. - -  - - - Click **Add apps** and search for **OpsPilot**. - -  - - - Select and add OpsPilot to the policy. - -  - - - Save the policy (deployment may take up to 24 hours). - -### Step 4: **User Setup** - - Generate an API key from OpsPilot Hub. - - Open Teams and go to the Apps tab. - -  - - - - Find OpsPilot under **Built for your organisation**. - - Add the app and open it. - - Navigate to the **Home** tab. - - - - - Enter the API key and click **Submit**. - - - - - - -!!! info - There is also a dropdown which allows for the app to be added in different contexts: -  - - - - - -!!! note - All other users in the organisation are now able to use the app as the API key is mapped to the organisation rather than the individual. - -## Usage Contexts - -### Personal Chat -- Direct one-on-one conversations with OpsPilot -- Functions similarly to standard OpsPilot - -### Group Chats -- Mention @OpsPilot to invoke the bot -- Bot responds in the group context - -### Channels/Teams -- Add OpsPilot to the Team -- Mention @OpsPilot to invoke -- Can be used in post titles and summaries -- Bot processes conversation history (up to 20 messages) - -## Features & Limitations - -### Available Features -- Basic chat functionality -- Integration with Teams contexts -- Message action support -- Conversation history processing - -### Limitations -- No image upload capability -- Non-interactive graphs -- No real-time status updates (only "Thinking..." status) -- 20-message conversation history limit - -## Actions - -Two available message actions: - -1. **Ask OpsPilot**: Invokes bot in current context. - -2. **Ask OpsPilot in DMs**: Forwards message to private chat. - - - -To use actions: - -1. Hover over any message -2. Click the ellipsis (...) -3. Select desired OpsPilot action - - - - - - - - diff --git a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/integrations-overview.md b/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/integrations-overview.md deleted file mode 100644 index 824384c..0000000 --- a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/integrations-overview.md +++ /dev/null @@ -1,34 +0,0 @@ -# Overview - -OpsPilot seamlessly integrates with your essential workplace tools to streamline incident response and monitoring workflows. Our integrations eliminate context-switching and bring OpsPilot's capabilities directly into your team's daily workflow. - -## Key Benefits -- Automatic context capture during incidents -- Reduced context switching -- Faster incident response -- Enhanced team collaboration - -## Available Integrations - -### Jira -- Create and manage tickets with full context -- Automatic duplicate detection -- Custom field support -- [Set up Jira integration →](/Data-insights/Features/OpsPilot/OpsPilot-Hub/Jira/) -### Slack -- Query OpsPilot directly in channels -- Share monitoring insights and visualizations -- Access via direct messages or mentions -- [Set up Slack integration →](/Data-insights/Features/OpsPilot/OpsPilot-Hub/Slack/) - -### Microsoft Teams -- Access OpsPilot via @mentions -- Interactive monitoring insights -- Team-wide visibility -- [Set up Microsoft Teams integration →](/Data-insights/Features/OpsPilot/OpsPilot-Hub/Teams/) - -### Pre-installed integrations -- Loki - logs -- Mimir - metrics -- Tempo - traces - diff --git a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/overview.md b/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/overview.md deleted file mode 100644 index 31e244e..0000000 --- a/docs/Data-insights/Features/OpsPilot/OpsPilot-Hub/overview.md +++ /dev/null @@ -1,32 +0,0 @@ -OpsPilot Hub is your central repository for storing, managing, and integrating critical operational information. It serves as both the knowledge base for the OpsPilot AI Assistant and your integration control center. Through the Hub, you can connect OpsPilot to essential tools like Jira for seamless ticket management and tracking. - -The Hub's knowledge base empowers OpsPilot to provide accurate, context-aware solutions to operational issues by combining your organization's information with integrated service data. By centralizing your operational knowledge and tool connections in one place, OpsPilot can quickly access relevant data and perform actions across your toolchain, enhancing its ability to assist team members in performing their roles effectively and efficiently. - - - - -## Overview dashboard features - -The overview page displays five cards showing different status elements: - -- **Release Status**: Displays latest updates and changes pushed to the OpsPilot Hub. - -- **Service Completion**: Highlights missing elements in service configuration (e.g. missing descriptions, incomplete fields etc). - -- **OpsPilot Assistant**: Direct access to OpsPilot chat history and interactions within the hub interface. - -- **Knowledge Analytics**: Displays overview of knowledge base searches, usage patterns, and available content types. - -- **Integrations Preview**: Showcases 3 randomly rotated integration options, allowing users to discover and directly access integration configuration. - - -OpsPilot Hub is accessible through the OpsPilot tab in the FusionReactor Cloud interface and currently offers the following primary sections: - -1. [Assistant](/Data-insights/Features/OpsPilot/OpsPilot-user-guide/): Elevate observability for every team member with the OpsPilot AI Assistant. - -2. [Services](/Data-insights/Features/OpsPilot/OpsPilot-Hub/Services/): Organize and manage your service-specific information. - -2. [Knowledge](/Data-insights/Features/OpsPilot/OpsPilot-Hub/Knowledge/): Add and maintain your organization's operational knowledge. - -3. [Integrations](/Data-insights/Features/OpsPilot/OpsPilot-Hub/integrations-overview/): Connect and configure third-party tools like Jira to extend OpsPilot's capabilities. - diff --git a/docs/Data-insights/Features/account.md b/docs/Data-insights/Features/account.md deleted file mode 100644 index 2bfd94f..0000000 --- a/docs/Data-insights/Features/account.md +++ /dev/null @@ -1,74 +0,0 @@ - -# Account - -## User types - -🔎**Find it**: **FusionReactor** > **Account** > **Users** - -FusionReactor Cloud has five types of user: - -* [Account Admin](/Cloud/guides/account/#account-admin) -* [Account Manager](/Cloud/guides/account/#account-manager) -* [Account User](/Cloud/guides/account/#account-user) -* [Account Observer](/Cloud/guides/account/#account-observer) -* [Business Contact](/Cloud/guides/account/#business-contact) - -The account types have a hierarchical structure and each level above **Observer** inherits from the level below. - -### Account Admin - -The **Admin** account type is the most powerful user type and has access to all of the features of the cloud including the ability to close the account and control the billing settings. As well as all of the features of **Manager**, the **Admin** level also allows users to: - -* Delete users from the account -* Configure alerting services -* Access account billing - -Typically, this user is seen as the account owner and billing contact and would be responsible for managing their FusionReactor Cloud account. - -### Account Manager - -The **Manager** level allows for account management, having access to all of the features of the standard User type but with the added ability to: - -* Add or update users on the account -* Manage configured applications -* Manage configured servers - -### Account User - -A **User** is the typical user level. They have access to all the features of the software with both read and write permission. - -### Account Observer - -The **Observer** account type is primarily a read only user. This user type has access to all of the main functionality albeit with a read only status. An observer has read and write access to their own data such as user information and quick links. - -### Business Contact - -A **Business Contact** account type is able to view the license keys for the account. - -## Adding a user - -🔎**Find it**: **FusionReactor** > **Account** > **Users** > **Add user** - - -1) To add a user, select **Add user**. - -  - -2) Complete the input boxes for **Email**, **First name** and **Last name**. - -3) Use the **Role** dropdown to select the account type: - - * **Account Admin** - - * **Account Manager** - - * **Account User** - - * **Account Observer** - -4) When all details are completed, select **Add user** at the bottom of the screen. - -___ - -!!! question "Need more help?" - Contact support in the chat bubble and let us know how we can assist. \ No newline at end of file diff --git a/docs/Data-insights/Features/alerting.md b/docs/Data-insights/Features/alerting.md deleted file mode 100644 index 4c33f17..0000000 --- a/docs/Data-insights/Features/alerting.md +++ /dev/null @@ -1,458 +0,0 @@ -# Alerting - -🔎**Find it**: **FusionReactor** > **Alerting** - - - -**FusionReactor Cloud Alerting** allows you to create automated checks on the values of metric data gathered by a -FusionReactor agent, and generate alerts when user-made conditions are met. - - - -The alerting system is comprised of **Checks** and **Subscriptions**: - -* [**Checks**](alerting.md#checks) are the conditions that are processed by the alerting engine. -* [**Subscriptions**](alerting.md#subscriptions) can be added to a check to notify via other services when an alert is generated. - -The alerting area can be found by selecting **Alerting** in the navigation bar, while -[alerting service configurations](alerting.md#configuring-alerting-services) can be found by clicking **Configurations**. - -!!! note - It is necessary to set-up alerting services before you can - start using them to make **Subscriptions**. - -## Checks - -🔎**Find it**: **FusionReactor** > **Alerting** > **Checks** - -In the **Checks** screen, you can perform the following actions: - -* View a check. - -* **Edit**, **Duplicate** or **Delete** a check. - - - - -### Alert status - -Hovering over the first icon at the right of the screen displays information about the alert. - - - -1. **Ok** - This alert has not passed its alert threshold. - -2. **Firing** - This check has passed its alert threshold - -3. **Pending** - The condition of this check has been created or modified and has not yet been checked. - -4. **Loading** - This check has been created and is being loaded by the alerting engine. - -5. **Updating** - The changes to this alert are still being updated - into the alerting engine. - -6. **Unknown** - The data for this check could not be found or processed. - -### Create a check - -🔎**Find it**: **FusionReactor** > **Alerting** > **Checks** > **+ Check** - -To create a check, select **+ Check** on the top right of page. - - - -The **Create new check** screen is displayed. - - - -!!! tip - We recommend only creating checks that fire when action to correct a situation is required. If you have too many alerts fire, we tend to find that alerts begin to be ignored. As a result crucial alerts that are important can be missed. - -!!! info - The alerting engine runs every 60 seconds. - -There are two ways to set a query: - -* [Builder](/Data-insights/Features/alerting/#builder) - -* [Code](/Data-insights/Features/alerting/#code) - -#### Builder - -**Step 1: Name your check** - -The first step in creating a check is naming it. - -!!! tip - Using a name that describes the situation firing the event is recommended. - -**Step 2: Set your query** - -The metrics list contains every metric that has been ingested into your cloud account - - - -Functions can be applied to your metric if required. - - - - -Functions include: - -- **Sum** -- **Average** -- **Count** -- **Min** -- **Max** -- **Group** -- **Standard deviation** -- **Unless** -- **Absent** - -The **Grouped by labels** dropdown will set which labels the data is grouped by, before a function is run on each group. - - - -Any changes to your metric selection, function or group will be applied to the graph showing the metric state. - - - -The timeframe of the metric can be adjusted from one hour, up to 2 weeks. - -**Step 3: Filter with labels** - - - -The alerting UI will display each label associated with your selected metric. - -* Select one or more label values to narrow down the data being monitored by the alert. - -* Add your own key/value pairs with **Add a label key**. - -* Selected labels will alter the metric graph values appropriately. - -**Step 4: Set your thresholds** - -Using the metric graph for reference, you can set your alert threshold. - - - -Use the selector to specify whether the value needs to be greater than, less than or equal to the threshold. - -**Step 5: Add subscriptions** - -Specify which of your existing subscriptions you would like your alert to be sent to, or alternatively create a new subscription. - - - -**Step 6: Optional configuration** - -You can set a summary and runbook for your alert notification. These are optional. - - - - -- **Summary** is a short description of the check, so the receiver knows what the alert is about. -- **Runbook** is for a URL. This is usually the location of the resources/instructions for *What to do when this alert fires*. - -The summary and runbook, if specified, will appear in your alert. - -#### Code - - -**Step 1: Name your check** - -The first step in creating a check is naming it. - -!!! tip - Using a name that describes the situation firing the event is recommended. - -**Step 2: Set your query** - -To build your query using PromQL, select the **code** button. - - - -The following screen is displayed: - - - -!!! example "Example Query" -  - -**Step 3: Set your thresholds** - -Using the metric graph for reference, you can set your alert threshold. - - - -Use the selector to specify whether the value needs to be greater than, less than or equal to the threshold. - -**Step 4: Add subscriptions** - -Specify which of your existing subscriptions you would like your alert to be sent to, or alternatively create a new subscription. - - - -**Step 5: Optional configuration** - -You can set a summary and runbook for your alert notification. These are optional. - - - -- **Summary** is a short description of the check, so the receiver knows what the alert is about. -- **Runbook** is for a URL. This is usually the location of the resources/instructions for *What to do when this alert fires*. - - -### Example checks - -* [Performance checks](/Data-insights/Features/alerting-examples/) -* [Billing/usage checks](/Data-insights/Features/billing-check/) - - - - -### Edit and duplicate checks - -**Edit** - Editing a check will provide you with a form identical to the form for creating one. It will be populated with the existing configuration of the check and when you save it the original check is overwritten. - -**Duplicate** - Duplicate similarly shows the same form with the check's settings already filled in. Selecting **Save** when duplicating will create a new check instead. - - -## Alert services - -🔎**Find it**: **FusionReactor** > **User Icon** > **Configuration** - -Subscriptions require a service they can send their subscribed alerts to. These are set-up in the configuration menu. - - - - -The following alerting services are currently supported: - -* **Email** -* [Gitlab](https://about.gitlab.com/) (via Email) -* **HTTP** (Webhook) -* [Microsoft Teams](https://products.office.com/en-us/microsoft-teams/group-chat-software/) (via HTTP webhook) -* [Slack](https://slack.com/) - -### Configure alerting services - -Service configurations can be found under [Alert services]( https://app.fusionreactor.io/configuration/alerts) in the -**Configuration** menu. From there you can configure the services you wish to use when creating subscriptions. - -To configure a service simply click the **Configure** next to that service. - - - - -A menu like the one shown below will appear: - - - -The required information differs for each service, and are explained in more detail below: - - -#### Email - -* Simply enable the service. -* Email addresses are set during subscription creation. - - -#### Http (Webhook) - -* Enter Webhook URL in the subscription during creation. - -#### Slack - -!!! info "Learn more" - [Slack](https://slack.com/) - -For the FusionReactor Cloud Slack app: - -* Click the **Add to Slack** button which will redirect you to the Slack website. - -* If required, sign into Slack, then review the requested permissions and allow the app access to your workspace. - -!!!note - The FusionReactor Cloud app will only have permission to **view** the name, email domain, and icon for your workspace. - **It cannot edit anything**. - - -!!! info "Learn more" - [Slack api](https://api.slack.com/scopes/team:read) - -!!!note - If you have to request approval from your Slack workspace admin, you will have to repeat these steps. An admin can approve - the request from the app management settings for your workspace or through a direct Slack message they will receive from **Slackbot**. - - After granting the app access, you will be redirected back to FusionReactor Cloud and your service will be configured. - -### Disable alerting services - -Clicking the toggle next to the service will switch it between being **Enabled** or **Disabled**. - -When a service configuration is disabled, the following will happen: - -* Each subscription that is linked to that service will be disabled. You will need to manually re-enable them after re-configuring the service. - -!!!note - You cannot re-enable the subscriptions until the service is enabled. - -* The settings saved on that service will be kept, so no extra set-up is required when re-enabling them. - -### Reset alerting services - -You can reset the configuration for a service by selecting **Reset** next to that service. - - - - -When a service configuration is reset, the following occurs: - -* Each subscription that is linked to that service will be disabled. You you will need to manually re-enable them after re-configuring the service. - -!!!note - You cannot re-enable the subscriptions until the service is enabled. - -* The settings saved on that service will be deleted, so any API keys and other information will need to be entered again when re-configuring them. - -## Subscriptions - -The subscriptions tab lets you manage and test your subscriptions. - - - -To view a subscription in more detail, select its name on the left-side of the row. - -## Create subscriptions - -Clicking the subscription button as shown below, will open the form for creating subscriptions. - - - -The **Create new subscription** screen is displayed: - - - -Within this form you will be able to set the active times and days of the subscription, as well as which alert states it watches for. - -Messages will only be sent to the subscribed service of those conditions that are met by an alert. Each service has different properties that may be configured, and will be explained in more detail below. - -### Email - -* **Subject** is for the email subject, which is "FusionReactor alert" by default. -* **Addresses** is where you list the email addresses of recipients for the subscription. -* **key** and **value** fields let you enter internet/email message headers as key:value pairs. - -### Gitlab - -Gitlab supports creating issues via email. -Follow [this guide](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#new-issue-via-email) to find out how. - -Flowdock doesn't require any additional configuration beyond the service configuration. - -### HTTP Webhooks - -* **Target URL** is required, as it is the URL that the alerts will be sent to. Your endpoint should provide this URL that - can be simply copied and pasted into the **Target URL** field. -* **Header** is for the internet message headers attached to requests. -* **Body** is for the body of the request. - -The end-point of the webhook will vary on what it requires, so be sure to check the documentation of your endpoint to -see what schema it follows. Then you can fill in the **Body** and **Header** to fit your needs. - -### Microsoft Teams - -To set-up alerting for MS Teams, you will need to set up a **Connector**. - -!!! info "Learn more" - [Connectors](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/connectors/connectors-using#setting-up-a-custom-incoming-webhook) - - -Once you have the URL, enter it into your subscription as the Target URL, as mentioned above for [webhooks](alerting.md#http-webhooks). - - -#### JSON schema used for MS Teams message cards - -!!! example - Copy and paste this into the **Body** of the webhook, or create your own. - - - ```json - { - "@type": "MessageCard", - "@context": "https://schema.org/extensions", - "summary": "FusionReactor Cloud Alert", - "themeColor": "479eff", - "sections": [ - { - "activityTitle": "FusionReactor Cloud", - "activitySubtitle" : "My alert title", - "activityImage": "https://www.fusion-reactor.com/wp-content/uploads/2013/01/frico1.png", - "text": "This text is here as a placeholder example of the webhook schema for MS Teams." - } - ], - "potentialAction": [ - { - "@type": "OpenUri", - "name": "View alerts", - "targets": [ - { - "os": "default", - "uri": "https://app.fusionreactor.io/alerting/alerts" - } - ] - } - ] - } - ``` - - Resulting output: - -  - - -!!! info "Learn more" - [Create message card](https://docs.microsoft.com/en-us/outlook/actionable-messages/message-card-reference#card-examples). - - -### Slack - -For the FusionReactor Cloud Slack app: - -* Select **Add to Slack** which will redirect you to the Slack website. -* If required, sign into Slack, and then select the channel you want alerts to appear in. -* After, you will be redirected back to FusionReactor Cloud where you can continue to configure your subscription. - -### Edit and duplicate subscriptions - -Clicking the **Edit** button on the row of the subscription you wish to edit will present you with an interface just like -the one used to [create subscriptions](/Data-insights/Features/alerting/#create-subscriptions). - -The values shown will match what's currently set on the subscription. Once you've made your desired changes, simply -click **Save** and your changes will overwrite on the subscription. - -If you don't wish to overwrite the existing subscription you can click **Duplicate**. The values shown will match what's currently set on the subscription you chose. You can changes before saving it. - -Clicking **Save** at the end of the form, creates a new subscription. - -### Delete and disable subscriptions - -Clicking **Delete** results in a message requesting confirmation that you wish to delete the subscription. Choosing **Ok** will delete the subscription from your account. - -!!! warning - This *cannot* be undone. - -Clicking the toggle under **Enabled** will enable or disable the subscription. The check will appear blue when enabled. - -While disabled, checks will not send alerts to that subscription and the subscription will not appear when looking at a check in the detailed view. - -If the [alert service](alerting.md#alerting-services) used by the subscription is not configured, or disabled, then the -subscription will be automatically disabled and cannot be enabled until the service is configured and enabled. - -___ - - -!!! 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/billing-check.md b/docs/Data-insights/Features/billing-check.md deleted file mode 100644 index 200de49..0000000 --- a/docs/Data-insights/Features/billing-check.md +++ /dev/null @@ -1,76 +0,0 @@ - - -# Billing usage checks - - -## Configuring usage-based billing alerts in FR Cloud - -This document describes how to configure alerts in FusionReactor Cloud to monitor your monthly usage of metrics, traces, logs, and agents, ensuring you stay within your allocated limits. - -**Procedure:** - -1. **Navigate to the Alerting section:** - * In the FusionReactor Cloud interface, access the **Alerting** tab. - -2. **Create a new check:** - * Click the **Create Check** button to initiate the alert configuration. - -3. **Specify the billing usage metric:** - * In the "Create new check" screen, locate the **Metric** field. - * Set the metric to `fr_billing_usage_current`. This metric represents the current monthly usage. - -  - -4. **Filter by service name:** - * Under the "Filter with labels" section: - * Set the filter label to `servicename`. - * Specify the exact service name for which you want to monitor usage. - * In the pictured example you'll see that the “traces” label has been selected. - - - !!! warning - Failure to specify a `servicename` will result in aggregated usage across all services, leading to inaccurate alerts. - -6. **Define the threshold:** - * Under the "Set the threshold" section: - * Set the **Operator** to `greater than`. - * Specify the **Threshold** value in bytes. - - !!! Example - To trigger an alert when trace usage reaches 80% of a 100GB limit, set the threshold to `80000000000` bytes (80GB * 1,000,000,000 bytes/GB). - -7. **Name and configure notifications:** - * Provide a descriptive **Name** for the check. - * Configure **Subscriptions** to specify how and where alerts should be delivered (e.g., email, Slack). - -8. **Activate the alert:** - * Save the check configuration. The alert is now active and will trigger when the specified usage threshold is exceeded. - - - -## Example alert configurations - -The following are examples of specific billing alert configurations using different metrics: - -### On-demand usage alert - -Triggers an alert based on on-demand usage charges, using the `fr_billing_charges_metered` metric. - -??? example "Example" -  - - * Monitors on-demand usage costs. - -### Billable data usage alert - -Triggers an alert based on total billable data usage, using the `fr_billing_usage` metric. - -??? example "Example" -  - - * Monitors the total amount of data subject to billing. - -### Total billing charges alert - -Provides information on total current billing charges, using the `fr_billing_charges_total` metric. - diff --git a/docs/Data-insights/Features/images/Alerting/billing-check.md b/docs/Data-insights/Features/images/Alerting/billing-check.md deleted file mode 100644 index f8f357b..0000000 --- a/docs/Data-insights/Features/images/Alerting/billing-check.md +++ /dev/null @@ -1,26 +0,0 @@ - - -# Billing usage checks - -## On-demand usage alert - -Triggers an alert based on on-demand usage charges, using the `fr_billing_charges_metered` metric. - -??? example "Example" -  - - * Monitors on-demand usage costs. - -## Billable data usage alert - -Triggers an alert based on total billable data usage, using the `fr_billing_usage` metric. - -??? example "Example" -  - - * Monitors the total amount of data subject to billing. - -## Total billing charges alert - -Provides information on total current billing charges, using the `fr_billing_charges_total` metric. - diff --git a/docs/Data-insights/Features/new-applications.md b/docs/Data-insights/Features/new-applications.md deleted file mode 100644 index af07966..0000000 --- a/docs/Data-insights/Features/new-applications.md +++ /dev/null @@ -1,88 +0,0 @@ -# Applications - - -The **Applications Overview** page provides a high-level visualization of all monitored applications within your environment. Each application is represented by a 3D cube, allowing users to quickly assess performance metrics such as throughput, transaction count, and error rates. - - - - -## **Key Elements** - - -Each cube represents a monitored application instance. Hovering over a cube displays detailed metrics in a tooltip, including: - -| Metric | Description | -| ------------------------------ | ---------------------------------------------------------------------------------------------- | -| **App Name** | The name of the application being monitored. | -| **App Txn Throughput Sum Max** | Maximum cumulative throughput (transactions per minute) recorded over the selected time range. | -| **App Txn Throughput Avg** | Average transaction throughput across the selected period. | -| **App Txn Throughput Max** | Peak transaction throughput observed. | -| **App Txn Throughput Cnt** | Current transaction count per minute (c/min). | -| **App Txn Error Count Sum** | Total number of errors recorded for this application. | - - -## Toolbar Controls - -Located at the top-right of the Applications Overview page are several key controls for time and data refresh management. - -| **Control** | **Description** | **Options / Function** | **Notes** | -| ------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| **Time Range Selector** | Adjusts the time frame of displayed data. | - Last 5 minutes