OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse OpenIM Guides
GUIDESOpenIM Guides

OpenIM guides organized by implementation stage, from product concepts and deployment to integration, extension, operations, and reliability.

Guides

Production Checks

Understand runtime failures, recovery order, and post-recovery checks.

Copy

This page explains the runtime impact of production failures, the recovery order, and post-recovery reconciliation.

General recovery order

  1. Restore external components.
  2. Restore OpenIMServer.
  3. Restore ChatServer.

External component failures

FailureRuntime impactRecovery
MongoDB unavailableOpenIMServer 10002 may still respond, but ChatServer and App Administrator APIs usually failRestore MongoDB; immediately retest 10002, 10008, and 10009, then restart OpenIMServer and ChatServer only if failures remain
Redis unavailableOpenIMServer authentication fails; source deployments commonly report auth-rpc-service down, while integrated Docker deployments report Redis connection or resolution errorsRestore Redis; wait 30-60s, then restart OpenIMServer if authentication still fails
Kafka unavailableBasic probes may remain healthy while message forwarding and push failRestore Kafka, then verify a complete message send, consume, and push cycle
Etcd unavailableRunning instances may continue briefly, but restarts can failRestore Etcd, then restart OpenIMServer and ChatServer if service registration does not recover
MinIO unavailableFile upload and download fail; integrated Docker deployments may also lose 10002, 10008, and 10009Restore MinIO and verify externalAddress; if probes remain unhealthy after 30-60s, restart the service stack

For openim-docker:

cd /path/to/openim-docker
docker compose up -d mongo redis kafka etcd minio

For an OpenIMServer source deployment:

cd /path/to/open-im-server
docker compose up -d mongodb redis kafka etcd minio
The default service name is mongo in openim-docker and mongodb in open-im-server.

OpenIMServer failures

ServiceRuntime impactRecovery
openim-api10002 is usually unavailableRestart from the open-im-server directory
openim-rpc-authOpenIMServer authentication probes fail, while ChatServer probes may remain availableRestart OpenIMServer
openim-msggatewayThe real-time WebSocket path is interruptedRestart OpenIMServer
openim-msgtransfer / openim-pushMessaging or push is degraded without necessarily failing basic probesRestart, then validate the complete message path
openim-crontaskScheduled jobs stopRestart OpenIMServer
cd /path/to/open-im-server
mage check
mage stop
mage start
mage check

ChatServer failures

ServiceRuntime impactRecovery
chat-apiApp business API 10008 is usually unavailableRestart from the chat directory
chat-rpcCore ChatServer operations fail although the HTTP port may remain openRestart ChatServer
admin-apiApp Administrator API 10009 is usually unavailable while 10008 may remain availableRestart ChatServer
admin-rpcApp Administrator business operations failRestart ChatServer
bot-api / bot-rpcBot capabilities failRestart ChatServer
cd /path/to/chat
mage check
mage stop
mage start
mage check

Post-recovery checks

  1. Confirm that mage check or docker ps is healthy.
  2. Confirm that the 10002, 10008, and 10009 probes have recovered.
  3. After Kafka or MinIO failures, also validate the message and file paths.

Basic OpenIMServer and ChatServer probes require an operationID request header.