# idea-indexing-metrics-collector

**Repository Path**: mirrors_elastic/idea-indexing-metrics-collector

## Basic Information

- **Project Name**: idea-indexing-metrics-collector
- **Description**: Intellij Idea plugin to push indexing metrics into an Elasticsearch cluster
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-14
- **Last Updated**: 2025-08-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# indexing-metrics-collector

<!-- Plugin description -->
Allows gathering [IntelliJ IDEA](https://www.jetbrains.com/idea/) project scanning & indexing metrics for further analysis by ingesting them into an [elasticsearch](https://www.elastic.co/elasticsearch/elasticsearch) cluster.

* [Project Home](https://github.com/elastic/idea-indexing-metrics-collector)
* [Issue Tracker](https://github.com/elastic/idea-indexing-metrics-collector/issues)

<!-- Plugin description end -->

This [IntelliJ IDEA](https://www.jetbrains.com/idea/) plugin gives developer teams the chance to analyse how much time they spent on indexing their projects.
The plugin captures indexing events occurred in IDEA and pushes them into an [elasticsearch](https://www.elastic.co/elasticsearch/elasticsearch)  cluster for further analyzise. 

The captured data per indexing event includes

- project name
- total indexing time in ms
- indexing reason
- duration of file scanning in ms
- indexing duration in ms
- update start
- update end
- was full indexing (true / false)
- was indexing interrupted (true / false)
- platform info 
  - idea application name 
  - version 
  - build number
  - plugin version
- runtime info 
  - max available processors
  - idea java memory settings 
  - indexing thread count)
- environment info
  - user name (can be optionally anonymized)
  - host name (can be optionally anonymized)
  - os name
  - os arch
  - os version

The [elasticsearch](https://www.elastic.co/elasticsearch/elasticsearch)  mapping template can be found here: [elasticsearch index mapping](https://github.com/elastic/indexing-metrics-collector/blob/main/src/main/resources/idea-indexing-mapping.json)

The idea for this came up when I heard first time about [shared project index](https://www.jetbrains.com/help/idea/shared-indexes.html#project-shared-indexes) for IntelliJ IDEA.
If you want to know the impact of such a plugin you need to have hard numbers first. In a distributed team gathering these numbers are tricky so the idea
for this plugin was born.

## Installation

[//]: # (- Using IDE built-in plugin system:)

[//]: # (  )
[//]: # (  <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "idea-index-tracker"</kbd> >)

[//]: # (  <kbd>Install Plugin</kbd>)

- From plugin repository:

  - In <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Manage plugin repositories...</kbd> 
  add 
   - for 2022.3.x use [https://raw.githubusercontent.com/elastic/indexing-metrics-collector/main/updatePlugins-223.xml](https://raw.githubusercontent.com/elastic/indexing-metrics-collector/main/updatePlugins-223.xml)
   - for 2022.2.x use [https://raw.githubusercontent.com/elastic/indexing-metrics-collector/main/updatePlugins-221.xml](https://raw.githubusercontent.com/elastic/indexing-metrics-collector/main/updatePlugins-221.xml)
    - for 2022.1.3+ use [https://raw.githubusercontent.com/elastic/indexing-metrics-collector/main/updatePlugins-213.xml](https://raw.githubusercontent.com/elastic/indexing-metrics-collector/main/updatePlugins-213.xml)
  - Install <b>indexing-metrics-collector</b> plugin

- Manually:

  Download the [latest release](https://github.com/idea/indexing-metrics-collector/releases/latest) and install it manually using
  <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>

## Configuration

The plugin provides a preference page to configure elasticsearch connection data including
authentication options and index name to be used and the option (enabled by default) to anonymize user data like host name and user name

![](docs/indexing-collector-preferences.png)

## Analyzing

The captured data allows gaining further insights why and how much time is spent on indexing in idea for your developers
This is an example [kibana](https://www.elastic.co/kibana/) dashboard used during development of this plugin

![](docs/kibana-dashboard-example.png)
---
Plugin based on the [IntelliJ Platform Plugin Template][template].

[template]: https://github.com/JetBrains/intellij-platform-plugin-template