Skip to content

Latest commit

 

History

History
209 lines (147 loc) · 8.7 KB

README.md

File metadata and controls

209 lines (147 loc) · 8.7 KB
Raw

Exporterhub.io Awesome

A Curated List of Prometheus Exporters

Powered by

Contents

Definition of ExporterHub.io

ExporterHub.io is an application for the Prometheus Exporters community.

ExporterHub.io is not just a curated list, but also provides exporter installation guide, alert rule configuration, and dashboard configuration. Each exporter's page contains the followings:

  • Official GitHub (Origin Repository)
  • Resource (Install, Exported Metrics)
  • Alert-rule (Recommended)
  • Dashboard (Grafana)
  • Star (linked to Github Origin Repository)
  • Fork to bucket (linked to personal Github Repository)
  • Edit Dashboard and Alert-rule by Admin

ExporterHub.io recommends the best-fit exporter(s) to support Prometheus monitoring needs in enterprise environments with complex and closed network security settings.

To help and ease you with best-practice Prometheus, ExporterHub.io discovers and recommends the best-fit exporter(s) available to expose metrics data from your specific systems and services being monitored.

The features that distinguish Exporterhub.io from other applications are:

  • Installation Guide, Metric Collection Flags, Recommended Alert-rule
  • Card Style GitHub Page
  • Admin Authorizaion(linked to organization of Github)
  • Register exporters, edit Dashboard and Alert by Admin(linked to Github organization Repository)
  • Easy search of Exporters
  • Personalization(fork/delete the exporter linked to Github personal Repository)
  • NexClipper Cloud Integration (coming soon)
    • Install exporters automatically
    • Generate Alert Rules
    • Recommend best-fit exporter(s)
  • Dev's Choice(coming soon)
    • Share my bucket
    • Search bar

Demo Video

  • Image click to Youtube for the full examples and guides:
    Demo

Diagram Overview

  • Image click to Youtube:
    • Diagram Overview

Kick-start

0. Ready: Token is required for GitHub information crawling

※ Github env settings below must be done under organization account settings, not in personal.

1. Create organization

2. Fork NexClipper/exporterhub.io to organization, not to personal account.

3. Create and register an OAuth app under your organization.

  • 1) Click developer settings tab of organization. While you create OAuth Apps, please take note of redirect url of authentication.

image

  • 2) Client ID, Client Secrets, and callback url(Service URL) are required for authentication.

4. Write docker-compose.yml accordingly.

  • "NEED_TO_SET_UP" parts are to be revised in ./.envfile, with the reference .env.SAMPLE file at /exporterhub.io:
REACT_APP_API_URL="NEED_TO_SET_UP"
REACT_APP_API_STATUS="y"
SERVICE_PORT="NEED_TO_SET_UP"

CLIENT_ID="NEED_TO_SET_UP"
CLIENT_SECRETS="NEED_TO_SET_UP"
SECRET_KEY="NEED_TO_SET_UP"
ALGORITHM="NEED_TO_SET_UP"
ORGANIZATION="NEED_TO_SET_UP"
CALLBACK_URL="NEED_TO_SET_UP"
  • "NEED_TO_SET_UP" parts are to be linked to docker-compose.yml as below:

5. build image before running

  • run the command make build at /exporterhub.io

6. Run by default(in localhost)

  • run the command make run at /exporterhub.io

7. Or, Run for external network

  • If you want to run the server in extenal server or instance, please make sure to input SERVICE_URL and CALLBACK_URL as same as below
services:
  expoterhub:
    image: nexclipper/exporterhub:release-fe0.3.4
    ports:
      - "${SERVICE_PORT}:3000"
    environment:
       SERVICE_PUBLIC: "n"
       # You can add and modify below setup to './.env' file for externel configuration without security issue.
       SERVICE_URL: ${REACT_APP_API_URL}
       CLIENT_ID: ${CLIENT_ID}
       CLIENT_SECRETS: ${CLIENT_SECRETS}
       CALLBACK_URL: ${CALLBACK_URL}
  • then, run the command make run at /exporterhub.io

8. Initial Check & Set

  • Inintial settings are done if you get landing page with exporter cards as below.

Maintenance

Easy to Update a list of exporters by Pull Request as below

Tag rule for Build in the hub.docker.com

exporterhub Frontend build tag

  • Source pattern of Tag: /^fe([0-9.]+)$/
    • ex) fe0.2.0 -> nexclipper/exporterhub:release-fe0.2.0

exporterhub API server build tag

  • Source pattern of Tag: /^api([0-9.]+)$/
    • ex) api0.3 -> nexclipper/exporterhub-api:release-api0.3

Docker image registry

References

Contribute

Contributions are welcome! If you have Specific exporter to contribute to ExporterHub.io, feel free to send issues or pull requests.
Please join us!: https://app.slack.com/client/TC3DP3HPG/C01RTA59G66

Service Map

servicemap

License

Exporterhub.io is licensed under the MIT License. See LICENSE for the full license text.

logging

  • Main branch has been changed from master

Supported by