qjoly / matomo-exporter Goto Github PK

This project is a Python script that exports data from a Matomo instance to Prometheus. It is designed to be as simple as possible to use and deploy in a container.

Since Matomo works with 'period' (day, week, month, year), the exporter will export the data for all types of periods and use labels to differentiate them.

• Create a docker-compose file with the following content:

services:
  matomo-exporter:
    build:
      context: .
      dockerfile: Dockerfile
    image: ghcr.io/qjoly/matomo-exporter:1.0.0
    restart: always
    ports:
      - 9000:9000
    env_file: .env
    environment:
      - LOG_LEVEL=DEBUG
      - SCRAPE_INTERVAL=60

• Create a .env file with the following content using your Matomo URL and token:

MATOMO_URL=https://matomo.yourdomain.com
MATOMO_TOKEN=yourtoken

Note: You can get your token by going to your Matomo instance on path /index.php?module=UsersManager&action=userSecurity or in the Auth tokens section of the Security tab.

• Run the container with the following command:

docker-compose up -d

• Access the metrics on http://localhost:9000/metrics.

You can configure the exporter using environment variables or arguments.

The following environment variables are available:

The following metrics are exported:

Contributions are welcome! Here are several ways you can contribute:

• Report Issues: Submit bugs found or log feature requests for the . project.
• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.