# gitee-exporter

**Repository Path**: oscstudio/gitee-exporter

## Basic Information

- **Project Name**: gitee-exporter
- **Description**: Prometheus exporter for gitee metrics
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 1
- **Created**: 2019-11-16
- **Last Updated**: 2025-06-23

## Categories & Tags

**Categories**: vcs

**Tags**: None

## README

# Prometheus Gitee Exporter

Exposes basic metrics for your repositories from the Gitee API, to a Prometheus compatible endpoint.

*( Most of the inspiration comes from [`github-exporter`](https://github.com/infinityworks/github-exporter), thanks to the [infinityworks team](https://github.com/infinityworks) for bringing us such wonderful examples. )*

## Configuration

This exporter is setup to take input from environment variables:

### Required
* `ORGS` If supplied, the exporter will enumerate all repositories for that organization. Expected in the format "org1, org2".
* `REPOS` If supplied, The repos you wish to monitor, expected in the format "user/repo1, user/repo2". Can be across different Gitee users/orgs.
* `USERS` If supplied, the exporter will enumerate all repositories for that users. Expected in
the format "user1, user2".

At least one of those 3 options should be provided.

### Optional
* `GITEE_TOKEN` If supplied, enables the user to supply a gitee authentication token that allows the API to be queried more often. Optional, but recommended.
* `GITEE_TOKEN_FILE` If supplied _instead of_ `GITEE_TOKEN`, enables the user to supply a path to a file containing a gitee authentication token that allows the API to be queried more often. Optional, but recommended.
* `API_URL` Gitee API URL, shouldn't need to change this. Defaults to `https://gitee.com/api/v5`
* `LISTEN_PORT` The port you wish to run the container on, the Dockerfile defaults this to `9190`
* `METRICS_PATH` the metrics URL path you wish to use, defaults to `/metrics`
* `LOG_LEVEL` The level of logging the exporter will run with, defaults to `debug`


## Install and deploy

Run manually from Docker Hub:
```
docker run -d --restart=always -p 9190:9190 -e REPOS="oscstudio/gitee-exporter, atompitestorg/testrepo" oscstudio/gitee-exporter
```

Build a docker image:
```
docker build -t <image-name> .
docker run -d --restart=always -p 9190:9190 -e REPOS="oscstudio/gitee-exporter, atompitestorg/testrepo" <image-name>
```

## Docker compose

```
gitee-exporter:
    tty: true
    stdin_open: true
    expose:
      - 9190
    ports:
      - 9190:9190
    image: oscstudio/gitee-exporter:latest
    environment:
      - REPOS=<REPOS you want to monitor>
      - GITEE_TOKEN=<your gitee api token>

```

## Metrics

Metrics will be made available on port 9190 by default
An example of these metrics can be found in the [`METRICS.md`](./METRICS.md) markdown file in the root of this repository

## Tests

There is a set of blackbox behavioural tests which validate metrics endpoint in the `test` directory. 
Run as follows

```bash
make test
```