Only this pageAll pages
Powered by GitBook
1 of 38

ClearInsights User Docs

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

ClearInsights Products

Loading...

Loading...

Loading...

Loading...

Using ClearInsights

Loading...

Loading...

Loading...

Loading...

Loading...

Introducing ClearInsights

What is ClearInsights?

ClearInsights is a platform that helps Dev Teams and Companies better manage events, bugs, information, performance & uptime for their applications and services.

ClearInsights Developer First Approach

At ClearInsights one of our core objectives is to reduce the time from which an issue is discovered for an application to when the issue is resolved. This is achieved by removing unnecessary bottle necks and empowering Dev Teams with the tools needed to achieve their goals. This benefits product teams with the ability to respond to unforeseen issues much faster and strengthening performance and stability for an organizations product catalog.

Additional resources

ClearInsights products

Logging: Product Team Approach To Application Logging

Logging is simple to integrate with applications and services using the ClearInsights SDK and easy to orchestrate and manage for product teams.

ClearInsights products
ClearInsights core concepts
ClearInsights Community Free Limitations

Azure

Integrate with Azure to connect all your cloud logs to ClearInsights.

Configuration

  • Configure unique mappings for each product and environment.

  • Ignore logs that you don't need to reduce cost and noise.

User Management

A user can span across multiple companies and have access to that companies resources based on the role that is assigned to that user by company.

User Roles

ClearInsights has a hierarchy that allows you to control access to features such as billing and integration. This hierarchy is as follows:

  • Global Admin: the highest level of access within a company, access to all resources.

  • Admin: admin access to all resources excluding organization settings and billing.

  • Contributor: contributor access to core products such as Logging & Monitoring.

Global Admin & Admin roles are able to invite new users to the company and set/update a users role.

Monitoring: is more than measuring performance

With ClearInsights monitoring you can measure an applications performance, uptime and custom insights.

ClearInsights Logging
ClearInsights Monitoring

ClearInsights Logging

ClearInsights core concepts

ClearInsights Documentation

ClearInsights User Documentation: providing a brief overview of available products, API & SDK usage & best practices.

Understanding ClearInsights

Explore ClearInsights Products

Core Products: Dive a little deeper

Learn the fundamentals of ClearInsights to get a deeper understanding of our main features:

Automation

ClearInsights automation in a nutshell...

Jira Automation

Integrate with Jira and automatically turn bugs into workable Jira issues for your team.

For more information see below:

Email Notification

Feature availability This feature is available with the Standard, Professional and Enterprise plans. See pricing plans for more details.

For more information see below:

Introducing ClearInsights Understanding ClearInsights core concepts and products.

Getting Started Start running ClearInsights products in your environments.

ClearInsights Logging Advanced logging for Dev Teams to better capture events, bugs & information with actionable insights.

ClearInsights Monitoring Integrated monitoring for applications & services in any environment.

ClearInsights Logging
ClearInsights Monitoring
Jira
Notifications

Azure DevOps Automation

Integrate with Azure DevOps and automatically turn bugs into workable Azure DevOps work items for your team.

For more information see below:

Azure DevOps

Project Management Integrations

Automation

Core Concept ClearInsights Automation can be an integral piece in providing Dev & Product teams with better processes for application support and performance.

Project Management Automation

Integrate with your Project Management platform to automatically create user stories when new bugs are logged.

Configure Integration

Configure integration to automate bug capture within your organizations SDLC process.

ClearInsights integrates with most modern project management platforms to help Dev & Product teams seamlessly capture and work on new bugs.

How it works?

Learn more

Companies, users and roles

Feature availability Some functions (such as Users) are available across multiple Companies.

ClearInsights has a hierarchy that allows you to control access to features such as billing and integration. This hierarchy is as follows:

  • Global Admin: the highest level of access within a company, access to all resources.

Create a ClearInsights account

You will need a ClearInsights account to use the platform and SDK.

Create an account

To create a ClearInsights account:

Integrate with ClearInsights SDK

DotNet Integration

ClearInsights Community Free Limitations

Community plan is free and is a simple start for everyone to get use to the ClearInsights platform. All new accounts will have unlimited access for 14 days. Below are some limitations if you remain on the community free plan after 14 days:

  • 1 user

  • 1 product

  • 1k records per month

Admin: admin access to all resources excluding organization settings and billing.

  • Contributor: contributor access to core products such as Logging & Monitoring.

  • ClearInsights companies

    A company/organization is the top level hierarchy that contains all resources for a group. Resources include logging records, monitoring records, reports, users, billing.

    ClearInsights Users

    A user can span across multiple companies and have access to that companies resources based on the role that is assigned to that user by company. User roles are Global Admin, Admin, Contributor.

    1k records per month Monitoring

  • User Documentation Support

  • 100 email notifications per month

  • Community plan is always free and is designed for individuals and students working on small projects.

    Logging
    Project Management Integrations
    ClearInsights Integrations

    Productivity Integrations

    Cloud Management Integrations

    ClearInsights Monitoring

    Go to https://clearinsights.io and click Sign Up at the top right of the page.

  • Select your preferred signup method.

  • You now have a free ClearInsights account! Access your ClearInsights account at https://app.clearinsights.io

  • Different pricing plans are available, see Plans for details.

    What's next?

    Follow the "Getting Started" walkthrough prompts

    Python Integration
    pip install ClearInsights

    Sample Projects

    PM> Install-Package ClearInsights
    > dotnet add package ClearInsights
    <PackageReference Include="ClearInsights" Version="x.x.xx" />
    > paket add ClearInsights

    Getting Started

    To start using ClearInsights, you need a ClearInsights account, and an application to integrate with.

    Quickstart

    1. Sign up to a ClearInsights account

    2. : create a product and 1 or more environments.

    3. to add logging and monitoring features to your applications and services.

    Log Analytics

    Connecting ClearInsights to your Azure Log Analytics workspace

    An Azure App Registration is required to connect and grant ClearInsights read access into your log analytics workspace.

    Creating An Azure App Registration

    1. Go To App Registration Service: Search for and navigate to Azure's App Registration service. This can be done by navigating to All Services page or searching via Azure portals main search bar.

    2. Create An App Registration: From the App Registration service > click on New Registration.

      • Add a name for this App Registration. (Suggested Name: ClearInsights Log Managment)

    It's recommended to create a new app registration as the sole purpose of this app registration is to grant ClearInsights read only access to the desired Log Analytics Workspaces.

    Connect ClearInsights to App Registration

    1. Grab your Tenant ID:

    2. Get Your App Client ID: From the Overview tab on your Azure App Registration - copy & paste the value of Application (client) ID into the ClearInsights Log Analytics Workspace form.

    3. Get Your Client Secret: From the Certificates & Secrets tab on your Azure App Registration - Create a new client secret and copy & paste the secret value into the ClearInsights Log Analytics Workspace form.

    Grant App Registration access to Log Analytics Workspace

    1. Go To Log Analytics workspaces Service: Search for and navigate to Azure's Log Analytics workspaces service. This can be done by navigating to All Services page or searching via Azure portals main search bar.

    2. Select the workspace: You may have more than 1 workspace available in this list, most likely separated by environment or resource group. Select the appropriate workspace(s) that contain the logs that you'd like to ingest into ClearInsights.

    3. Grant Access: From the Access control (IAM) blade > Select the "Role assignments" tab.

    Additional Resources

    Getting started with ClearInsights Monitoring

    Status Pages

    Add 1 or more Health Status Configurations to design a Status Page. A company can have 1 or more status pages which will show the team the health status of integrated products and environments. These health status are determined by the conditions created while configuring Health Status explained in Setup Health Status Configuration.

    Here you can see the status of each product and each environment within the product

    Performance

    While using the ClearInsights SDK you can measure the CPU and Memory consumption of your applications and services. This data then visualized on the ClearInsights portal as shown below:

    Configuration

    See Getting Started Health Status Configuration for details

    Reports

    Reporting gives you an overview of Operational, Unhealthy and Down statuses for your applications and services. You can filter by date range and top 5, 10, 15 to get insight into errors that occur most frequently.

    Settings

    Settings is where you can who can receive which kind of notifications and how frequently. For more see:

    Setup your first product

    Products can be used to group applications by functional areas or by purpose. Each product can have 1 or more environments. Ex. Development, QA, Production.

    Creating a product

    Creating a product is easy, simply add a product name and (optional) description.

    Creating a product environment

    After creating a product, navigate to the product detail page to create/view environments. This is also where you can get/re-key client secrets.

    Add an environment name to create a product environment.

    After you've created your first product environment all other environments can be created by selecting the "Add New Environment" option from the drop down.

    Slack

    Integrate with Slack and get notifications about application logs, bugs and availability

    Configuration

    • Configure unique automation for each product and environment.

    • Configure which log types will be used to automatically send Slack notifications when captured.

    • Configure the channel that automated notifications will be sent to.

    • Configure the frequency the ClearInsights will send notifications to your Slack channel.

    Remember to Grant Permission so that ClearInsights can send notifications on your behalf.

    Jira

    Integrate with Jira and automatically turn bugs into workable Jira issues for your team.

    Configuration

    • Configure unique automation for each product and environment.

    • Decide which log types will be used to automatically create Jira issues when captured.

    • Decide which Jira project these issues will be created under.

    • Set who these issues will be assigned to.

    • Decide the grace period for creating new Jira issues that are similar to issues that have already been closed.

    Remember to Grant Permission so that ClearInsights can create issues on your behalf.

    Azure DevOps

    Integrate with Azure DevOps and automatically turn bugs into work items for your team.

    Configuration

    AWS

    Integrate with AWS to connect all your cloud logs to ClearInsights.

    AWS Account and Access Keys

    Setup Health Status Configuration

    At least 1 product and 1 product environment must be created before proceeding to configuring health status.

    Add 1 or more conditions to your product/environment that will determine its health.

    Condition Types

    Create Health Status Page

    At least 1 Health Status Configuration must be configured before proceeding with creating a Health Status Page.

    Add 1 or more Health Status Configurations to design a Status Page. A company can have 1 or more status pages which will show the team the health status of integrated products and environments. These health status are determined by the conditions created while configuring Health Status explained in .

    ClearInsights Integrations

    ClearInsights Integrations help Dev & Product teams seamlessly manage and resolve unforeseen issues that may occur within their applications and services.

    Integration Types

    Notifications

    Feature availability This feature is available with the Standard, Professional and Enterprise plans. See pricing plans for more details.

    ClearInsights notifications are fully customizable and enable users and organizations to receive alerts depending on the criteria configured.

    Personal Access Token

    An Azure DevOps PAT (Personal Access Token) is required to use ClearInsights Azure DevOps integration.

    Required Configuration

    Set up your first product
    Integrate with ClearInsights SDK
    Setup Health Status Configuration
    Setup Health Status Configuration
    Notifications

    Configure unique automation for each product and environment.

  • Add 1 or more DevOps organizations to use for configuration. You will need to create a Personal Access Token.

  • Decide which log types will be used for automation.

  • Additional Information

    Personal Access Token
    Choose Supported Account Type (Recommended: Accounts in this organizational directory only)

    Get Your Log Analytics Workspace ID: In Azure, go to Log Analytics workspaces > Select Workspace and then "Overview" tab. From here you can retrieve a Workspace ID. Copy & paste this Workspace ID into the ClearInsights Log Analytics Workspace form.

    Click on "Add role assignment" under the Add menu.

  • Select "Reader" from the Role tab.

  • Assign access to User, group, or service principal

  • Members: Click select members > Search for the name of the App Registration created above (Suggested Name: ClearInsights Log Managment)

  • Save: Click "Review + Assign". Your app registration should now have read access to this log analytics workspace.

  • How to find your Azure Tenant ID?

    Open the IAM console at https://console.aws.amazon.com/iam/.

  • On the navigation menu, choose Users.

  • Choose your IAM user name (not the check box).

  • Open the Security credentials tab, and then choose Create access key.

  • To see the new access key, choose Show. Your credentials resemble the following:

    • Access key ID: AKIAIOSFODNN7EXAMPLE

    • Secret access key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

  • To download the key pair, choose Download .csv file. Store the .csv file with keys in a secure location.

  • Important

    • Keep the keys confidential to protect your AWS account, and never email them. Do not share them outside your organization, even if an inquiry appears to come from AWS or Amazon.com. No one who legitimately represents Amazon will ever ask you for your secret key.

    • You can retrieve the secret access key only when you initially create the key pair. Like a password, you can't retrieve it later. If you lose it, you must create a new key pair.

    Granting Access To CloudWatch

    The user in which you're creating the Access Key for as shown above must also have access to retrieve data from CloudWatch logs.

    Conditions are used to determine specific scenarios in which a product is determined to be healthy.

    Dynamic Condition

    Dynamic conditions are used to receive a json response from an application or service at a specific time or interval. If this condition is not met by the configured standards, this product will be marked as unhealthy or down.

    Performance Condition

    Performance conditions are used to measure the CPU and Memory consumption of an application or service. If this condition is not met depending on the configuration parameters, this product will be marked as unhealthy or down.

    Ping Condition

    Ping conditions are used to measure the uptime status or Web Applications, API's & HTTP endpoints. If this condition is not met depending on the configuration parameters, this product will be marked as unhealthy or down.

    Project Management are designed to seamlessly report new bugs to a configured backlog.

    Cloud Management are designed to seamlessly connect cloud logs to ClearInsights.

    Productivity are designed to connect ClearInsights to your favorite apps for improved productivity and collaboration.

    Logging Notifications

    Configure 1 or more notification settings to receive alerts when logs are captured.

    Monitoring Notifications

    Configure 1 or more notification settings to receive alerts when monitoring conditions are not met.

    Work Items: Read, write & manage

    This gives ClearInsights the ability to create Azure DevOps work items on your behalf.

    Additional Resources for creating a Personal Access Token

    Getting started with ClearInsights Logging

    Logs

    Log Types

    Project Management Integrations
    Cloud Management Integrations
    Productivity Integrations

    Critical: For failures that require immediate attention. Examples: data loss scenarios, out of disk space.

  • Error: For errors and exceptions that cannot be handled. These messages indicate a failure in the current operation or request, not an app-wide failure.

  • Warning: For abnormal or unexpected events. Typically includes errors or conditions that don't cause the app to fail.

  • Informational: Tracks the general flow of the app. May have long-term value.

  • Trace: Contain the most detailed messages. These messages may contain sensitive app data. These messages are disabled by default and should not be enabled in production.

  • Overview

    For each log you will see information related to the message, product, environment, source and stack trace. Insights tab will be available depending on the discovery of additional information.

    Reports

    Reporting gives you an overview of Critical and Error log types. You can filter by date range and top 5, 10, 15 to get insight into errors that occur most frequently.

    Settings

    Settings is where you can who can receive which kind of notifications and how frequently. For more see:

    Notifications

    Plans

    ClearInsights platform is available with several pricing plans, from free to Enterprise-level:

    • Free: A simple start for everyone. For individual developers and students working on small projects.

    • Standard: For growing teams looking to build advanced insights into their applications and services.

    • Professional: For small to medium sized business focused on improving processes, empowering product teams and strengthening their products.

    • Enterprise: Solutions for larger organizations looking to improve app & process performance.

    Sign up to use ClearInsights for free!
    GitHub - ClearInsights/ClearInsights.ConsoleGitHub
    GitHub - ClearInsights/ClearInsights.ASPNetCoreGitHub
    Logo
    Logo
    Identity and access management for Amazon CloudWatch Logs - Amazon CloudWatch LogsAmazon CloudWatch Logs
    Logo
    Authenticating the AWS Tools for PowerShell with AWS - AWS Tools for PowerShell (version 5)AWS Tools for PowerShell (version 5)
    Logo
    Create Log Analytics workspaces - Azure MonitorMicrosoftLearn
    Logo
    Use Personal Access Tokens - Azure DevOpsMicrosoftLearn
    Logo
    How to find your tenant ID - Microsoft EntraMicrosoftLearn
    Logo