mirror of
https://github.com/hanzoai/team.git
synced 2026-11-01 07:55:31 +00:00
5fe06ac4d0
Ports content drift from the legacy Sphinx docs repo (mattermost/docs) since the P13 migration fork point into the corresponding Administration Guide > Manage MDX pages: - ABAC v11.7/v11.8: public channel membership policies (advisory vs. hard-gate behavior), channel-level permission policies, policy simulation, and team-scoped membership policies in Team Settings (abac-channel-access-rules, abac-system-wide-policies, attribute-based-access-control) - User Attributes: separate Display Name/Attribute name fields, backfill note, terminology updates - Content flagging: quarantined message report generation and post deletion report documentation - Autotranslation: translation target language and language-pair clarifications - Generating support packet: sanitize typo fixes, removed stale ElasticsearchSettings.ClientKey reference - Installing license key: Site Statistics -> System Statistics rename - Team/channel members: SetChannelMembers bulk API note - Telemetry: removed Rudder/Segment-specific reporting details following the telemetry stack migration - Statistics: Site Statistics -> System Statistics rename - Health check probes: corrected Go import path example - mmctl: documented --workers flag for import process, renamed Custom Profile Attribute -> User Attribute in cpa command docs - Logging: removed unused audit log file rotation settings from the Cloud defaults note Co-authored-by: Hanzo Dev <[email protected]>
49 lines
2.1 KiB
Plaintext
49 lines
2.1 KiB
Plaintext
---
|
|
title: "Configure server health check probes"
|
|
---
|
|
<PlanAvailability slug="entry-ent" />
|
|
|
|
This page describes how to configure health check probes for a Mattermost server.
|
|
|
|
Before you begin, you should have a running Mattermost server. If you don't, you can [install Mattermost on various distributions](/deployment-guide/deployment-guide-index).
|
|
|
|
<Note>
|
|
|
|
[Highly available Mattermost cluster support](/administration-guide/scale/high-availability-cluster-based-deployment) requires Mattermost Enterprise.
|
|
|
|
</Note>
|
|
|
|
You can perform a health check with the following 2 methods:
|
|
|
|
- [ping the APIv4 endpoint](#ping-the-apiv4-endpoint)
|
|
- [ping the Mattermost server](#ping-the-mattermost-server)
|
|
|
|
## Ping the APIv4 endpoint
|
|
|
|
You can use the [GET /system/ping APIv4 endpoint](https://api.mattermost.com/#tag/system%2Fpaths%2F~1system~1ping%2Fget) to check for system health.
|
|
|
|
A sample request is included below. The endpoint checks if the server is up and healthy based on the configuration setting `GoRoutineHealthThreshold`.
|
|
|
|
- If `GoRoutineHealthThreshold` and the number of goroutines on the server exceeds that threshold, the server is considered unhealthy.
|
|
- If `GoRoutineHealthThreshold` is not set or the number of goroutines is below the threshold the server is considered healthy.
|
|
|
|
This endpoint can also be provided to schedulers like [Kubernetes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/).
|
|
|
|
``` go
|
|
import "github.com/mattermost/mattermost/server/public/model"
|
|
|
|
Client := model.NewAPIv4Client("https://your-mattermost-url.com")
|
|
Client.Login("[email protected]", "Password1")
|
|
|
|
// GetPing
|
|
status, err := Client.GetPing()
|
|
```
|
|
|
|
## Ping the Mattermost server
|
|
|
|
The [Mattermost Probe](https://github.com/csduarte/mattermost-probe) constantly pings a Mattermost server using a variety of probes.
|
|
|
|
These probes can be configured to verify core features, including sending and receiving messages, joining channels, pinging a login page, and searching of users and channels.
|
|
|
|
The project is contributed by the Mattermost open source community. Suggestions and contributions for the project are welcome.
|