Skip to main content

Insights

Overview​

The Insights panel offers quantitative summaries about key usage metrics for your account.

These metrics help you track Komment usage across your team and make data-driven decisions about financial savings, productivity gains, and return on investment (ROI) that Komment provides.

All statistics in this view are refreshed after each pipeline run, ensuring you always have the most up-to-date snapshot of your usage.

You can access the Insights panel by clicking the graph icon in the main menu.

Insights view in dashboard

Savings Delivered: This metric tracks the financial savings Komment has provided. It totals the dollar value saved across all repositories you've accessed since becoming a Komment user.

Developer salary: Set the average salary for developers in your organization to get a customized ROI estimate. Simply use the interactive slider to set a number. The default value is $100,000.

Hours Saved: The time Komment has saved your team, calculated based on how long it would take a developer to manually write the same amount of documentation.

Our predictive models consider your codebase's type, complexity, and volume to estimate the time saved from manual documentation. They also factor in time saved on subsequent tasks due to the availability of reliable documentation.

Total Runtime: The cumulative time Komment has spent processing and generating documentation for all your repositories.

Languages Documented: A list of icons denoting the languages that Komment has documented in your repositories.

Lifetime Totals​

Lifetime Totals provide details about your team’s usage of Komment.

Lifetime total metrics

(1) Name of the metric

(2) Cumulative total for this metric since you started using Komment.

(3) Percentage change in usage this month over the previous month.

(4) Plot of monthly usage for this metric up until your most recently run pipeline.

(5) The exact value of the metric for a given month.

You can hover over the plot to see an exact month by month breakdown of each metric.

Metrics​

Lines of Code: Total lines of code documented by Komment since your registration. This count excludes blank lines, comments, import statements, and structural lines.

Files Documented: Total number of unique files Komment has documented across all your repositories.

Items Ingested: Total number of unique code elements Komment extracted from your codebase.

An item is a code construct — such as a function, class, method or module — that Komment identifies as relevant to documentation.

Items Documented: Total number of unique code elements Komment has documented. Komment takes an opinionated approach to documentation, actively deciding which ingested items to document based on your project's context. As a result, documented items are an intelligently filtered subset of the total items ingested.

Activity Distribution​

These graphs further visualize a breakdown of your team’s activity on Komment. Inside of each graph is a total number for each activity metric, and the pie chart itself contains a detailed breakdown for more granular insights.

Activity distributions

(1) Total number for each activity metric

(2) Name of activity metric

(3) Detailed activity distribution

(4) Percentage of highlighted segment in total

Activity distribution graphs are interactive — just hover over a graph to see exact activity percentages.

Activities​

Developers: Total number of contributors across all your connected repositories, broken down by the proportion of pipelines ran for each developer.

Pipelines: Total pipelines Komment has run, broken down by the end status of pipelines, which could be COMPLETED, SKIPPED, STOPPED and FAILED

Repositories: Total number of repositories Komment has documented for you, along with the distribution of pipelines across these repositories.

Languages: Total number of programming languages Komment has documented across your repositories, along with the distribution of languages by pipeline runs.