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:

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.

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.

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.

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.

Monitoring: is more than measuring performance

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

Project Management Automation

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

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

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

Quickstart

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

• User Documentation Support

• 100 email notifications per month

Creating a product

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

Creating a product environment

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.

Create an account

To create a ClearInsights account:

2. Select your preferred signup method.

What's next?

Follow the "Getting Started" walkthrough prompts

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

DotNet Integration

PM> Install-Package ClearInsights

> dotnet add package ClearInsights

<PackageReference Include="ClearInsights" Version="x.x.xx" />

> paket add ClearInsights

Python Integration

pip install ClearInsights

Sample Projects

Integration Types

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

Condition Types

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.

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.

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

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.

Configuration

• Configure unique automation for each product and environment.

• Decide which log types will be used for automation.

Additional Information

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)

   • Choose Supported Account Type (Recommended: Accounts in this organizational directory only)

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

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.

4. 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.

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.

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

   2. Select "Reader" from the Role tab.

   3. Assign access to User, group, or service principal

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

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

Additional Resources

Configuration

• Configure unique mappings for each product and environment.

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

AWS Account and Access Keys

2. On the navigation menu, choose Users.

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

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

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

   • Access key ID: AKIAIOSFODNN7EXAMPLE

   • Secret access key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

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

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.

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.

Required Configuration

• Work Items: Read, write & manage

Additional Resources for creating a Personal Access Token

Logs

Log Types

• 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:

Status Pages

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:

For more information see below:

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.

ClearInsights automation in a nutshell...

For more information see below:

For more information see below: