Mattermost plugin minotor

Export some Mattermost metrics for Prometheus:

# HELP mattermost_db_connections_idle The number of idle connections.
# TYPE mattermost_db_connections_idle gauge
mattermost_db_connections_idle 0
# HELP mattermost_db_connections_in_use The number of connections currently in use.
# TYPE mattermost_db_connections_in_use gauge
mattermost_db_connections_in_use 0
# HELP mattermost_db_idle_connections_closed_total The total number of connections closed due to SetMaxIdleConns.
# TYPE mattermost_db_idle_connections_closed_total gauge
mattermost_db_idle_connections_closed_total 0
# HELP mattermost_db_idle_time_connections_closed_total The total number of connections closed due to SetConnMaxIdleTime.
# TYPE mattermost_db_idle_time_connections_closed_total gauge
mattermost_db_idle_time_connections_closed_total 0
# HELP mattermost_db_lifetime_connections_closed_total The total number of connections closed due to SetConnMaxLifetime.
# TYPE mattermost_db_lifetime_connections_closed_total gauge
mattermost_db_lifetime_connections_closed_total 0
# HELP mattermost_db_max_open_connections Maximum number of open connections to the database.
# TYPE mattermost_db_max_open_connections gauge
mattermost_db_max_open_connections 0
# HELP mattermost_db_open_connections The number of established connections both in use and idle.
# TYPE mattermost_db_open_connections gauge
mattermost_db_open_connections 0
# HELP mattermost_db_wait_count The total number of connections waited for.
# TYPE mattermost_db_wait_count gauge
mattermost_db_wait_count 0
# HELP mattermost_db_wait_duration_seconds The total time blocked waiting for a new connection (seconds).
# TYPE mattermost_db_wait_duration_seconds gauge
mattermost_db_wait_duration_seconds 0
# HELP mattermost_kpi_channels_total Number of channels by type
# TYPE mattermost_kpi_channels_total gauge
mattermost_kpi_channels_total{type="direct"} 2
mattermost_kpi_channels_total{type="private"} 1
mattermost_kpi_channels_total{type="public"} 2
# HELP mattermost_kpi_last_post_date Timestamp of last post date
# TYPE mattermost_kpi_last_post_date gauge
mattermost_kpi_last_post_date 1.734876978606e+12
# HELP mattermost_kpi_posts_total Total number of posts
# TYPE mattermost_kpi_posts_total gauge
mattermost_kpi_posts_total 49
# HELP mattermost_kpi_reaction_last_seconds Last reaction time - unix timestamp
# TYPE mattermost_kpi_reaction_last_seconds gauge
mattermost_kpi_reaction_last_seconds 1.73488381211e+12
# HELP mattermost_kpi_reaction_total Count by emoji (top 5)
# TYPE mattermost_kpi_reaction_total gauge
mattermost_kpi_reaction_total{emoji=""} 1
mattermost_kpi_reaction_total{emoji="grinning"} 1
# HELP mattermost_kpi_sessions_total Total number of sessions
# TYPE mattermost_kpi_sessions_total gauge
mattermost_kpi_sessions_total 59
# HELP mattermost_system_database_status Database component status
# TYPE mattermost_system_database_status gauge
mattermost_system_database_status 1
# HELP mattermost_system_filestore_status Filestore component status
# TYPE mattermost_system_filestore_status gauge
mattermost_system_filestore_status 1
# HELP mattermost_usage_info Mattermost server info
# TYPE mattermost_usage_info gauge
mattermost_usage_info{edition="free",sqldriver="postgres",version="10.1.6"} 1
# HELP mattermost_usage_job_last_seconds Last job execution time - unix timestamp
# TYPE mattermost_usage_job_last_seconds gauge
mattermost_usage_job_last_seconds 1.734890073205e+12
# HELP mattermost_usage_job_total Jobs count by status and type
# TYPE mattermost_usage_job_total gauge
mattermost_usage_job_total{status="error",type="product_notices"} 1
mattermost_usage_job_total{status="success",type="active_users"} 48
mattermost_usage_job_total{status="success",type="cleanup_desktop_tokens"} 29
mattermost_usage_job_total{status="success",type="delete_dms_preferences_migration"} 1
mattermost_usage_job_total{status="success",type="delete_empty_drafts_migration"} 1
mattermost_usage_job_total{status="success",type="delete_orphan_drafts_migration"} 1
mattermost_usage_job_total{status="success",type="expiry_notify"} 174
mattermost_usage_job_total{status="success",type="migrations"} 1
mattermost_usage_job_total{status="success",type="product_notices"} 28
mattermost_usage_job_total{status="success",type="refresh_post_stats"} 10
# HELP mattermost_usage_posts_total Total number of posts
# TYPE mattermost_usage_posts_total gauge
mattermost_usage_posts_total 0
# HELP mattermost_usage_start_time_seconds Start time of the process since unix epoch in seconds
# TYPE mattermost_usage_start_time_seconds gauge
mattermost_usage_start_time_seconds 1.733689461e+09
# HELP mattermost_usage_status Global status
# TYPE mattermost_usage_status gauge
mattermost_usage_status 1
# HELP mattermost_usage_storage_bytes Storage usage in bytes
# TYPE mattermost_usage_storage_bytes gauge
mattermost_usage_storage_bytes 0
# HELP mattermost_usage_users_total Total number of users
# TYPE mattermost_usage_users_total gauge
mattermost_usage_users_total 0
# HELP promhttp_metric_handler_errors_total Total number of internal errors encountered by the promhttp metric handler.
# TYPE promhttp_metric_handler_errors_total counter
promhttp_metric_handler_errors_total{cause="encoding"} 0
promhttp_metric_handler_errors_total{cause="gathering"} 0

Getting Started

Installation

Download and install the plugin https://developers.mattermost.com/integrate/plugins/using-and-managing-plugins/

Usage

Configure your Prometheus or Grafana alloy to scrap endpoint: /plugins/org.ebuildy.plugin-minotor/metrics

<!> There is no authentication, you must protect this endpoint from public access <!>

Development

To avoid having to manually install your plugin, build and deploy your plugin using one of the following options. In order for the below options to work, you must first enable plugin uploads via your config.json or API and restart Mattermost.

    "PluginSettings" : {
        ...
        "EnableUploads" : true
    }

Deploying with Local Mode

If your Mattermost server is running locally, you can enable local mode to streamline deploying your plugin. Edit your server configuration as follows:

{
    "ServiceSettings": {
        ...
        "EnableLocalMode": true,
        "LocalModeSocketLocation": "/var/tmp/mattermost_local.socket"
    },
}

and then deploy your plugin:

make deploy

You may also customize the Unix socket path:

export MM_LOCALSOCKETPATH=/var/tmp/alternate_local.socket
make deploy

If developing a plugin with a webapp, watch for changes and deploy those automatically:

export MM_SERVICESETTINGS_SITEURL=http://localhost:8065
export MM_ADMIN_TOKEN=j44acwd8obn78cdcx7koid4jkr
make watch

Deploying with credentials

Alternatively, you can authenticate with the server's API with credentials:

export MM_SERVICESETTINGS_SITEURL=http://localhost:8065
export MM_ADMIN_USERNAME=admin
export MM_ADMIN_PASSWORD=password
make deploy

or with a personal access token:

export MM_SERVICESETTINGS_SITEURL=http://localhost:8065
export MM_ADMIN_TOKEN=j44acwd8obn78cdcx7koid4jkr
make deploy

Releasing new versions

The version of a plugin is determined at compile time, automatically populating a version field in the plugin manifest:

• If the current commit matches a tag, the version will match after stripping any leading v, e.g. 1.3.1.
• Otherwise, the version will combine the nearest tag with git rev-parse --short HEAD, e.g. 1.3.1+d06e53e1.
• If there is no version tag, an empty version will be combined with the short hash, e.g. 0.0.0+76081421.

To disable this behaviour, manually populate and maintain the version field.

How to Release

To trigger a release, follow these steps:

1. For Patch Release: Run the following command:

   make patch
   

   This will release a patch change.

2. For Minor Release: Run the following command:

   make minor
   

   This will release a minor change.

3. For Major Release: Run the following command:

   make major
   

   This will release a major change.

4. For Patch Release Candidate (RC): Run the following command:

   make patch-rc
   

   This will release a patch release candidate.

5. For Minor Release Candidate (RC): Run the following command:

   make minor-rc
   

   This will release a minor release candidate.

6. For Major Release Candidate (RC): Run the following command:

   make major-rc
   

   This will release a major release candidate.

Q&A

How do I make a server-only or web app-only plugin?

Simply delete the server or webapp folders and remove the corresponding sections from plugin.json. The build scripts will skip the missing portions automatically.

How do I include assets in the plugin bundle?

Place them into the assets directory. To use an asset at runtime, build the path to your asset and open as a regular file:

bundlePath, err := p.API.GetBundlePath()
if err != nil {
    return errors.Wrap(err, "failed to get bundle path")
}

profileImage, err := ioutil.ReadFile(filepath.Join(bundlePath, "assets", "profile_image.png"))
if err != nil {
    return errors.Wrap(err, "failed to read profile image")
}

if appErr := p.API.SetProfileImage(userID, profileImage); appErr != nil {
    return errors.Wrap(err, "failed to set profile image")
}