mediawiki_exporter

command module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 3, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

README

Mediawiki Exporter

A Prometheus exporter for Mediawiki.

Emits the following metrics so far:

  • mediawiki_statistics_activeusers: Current number of active users.
  • mediawiki_statistics_admins: Current number of administrators.
  • mediawiki_statistics_articles: Current number of articles.
  • mediawiki_statistics_edits: Current number of edits.
  • mediawiki_statistics_images: Current number of images.
  • mediawiki_statistics_jobs: Current number of jobs.
  • mediawiki_statistics_pages: Current number of pages.
  • mediawiki_statistics_users: Current number of users.

The container image for the exporter is available at clockworksoul/mediawiki-exporter.

Execution

To execute this exporter, you must specify the URL of the Mediawiki instance that's being evaluated. This can be one of two ways.

  1. As the only argument parameter.
  2. Via the MEDIAWIKI_API_URL.

Environment variables

This exporter supports three optional environment variables.

  1. MEDIAWIKI_API_URL -- Specifies the URL of the evaluated Mediawiki instance.
  2. MEDIAWIKI_USERNAME -- The bot username (not a user username), if authentication is required.
  3. MEDIAWIKI_PASSWORD -- The bot password (not a user password), if authentication is required.

Exit status codes

Different failure modes return different status codes.

  • 2: General Mediawiki login failure
  • 3: API URL not specified
  • 4: Bot username/password are could not be authenticated
  • 5: Access denied by Mediawiki

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL