Service Status

Service health and status monitoring queries

Audience: System Administrator

pyck provides dedicated queries for monitoring the health and status of each microservice in the system. These queries are essential for:

• Health checks and monitoring

• Deployment verification

• Version tracking

• Service availability monitoring

Available Service Status Queries

Each pyck service exposes a status query that returns ServiceInfo with version and deployment information:

• inventory - Inventory service status

• main_data - Main data service status

• management - Management service status

• picking - Picking service status

• receiving - Receiving service status

• file - File service status

• workflow - Workflow service status

Return Type

All service status queries return the ServiceInfo type containing:

• version - Service version string

• date - Build/deployment date

Usage Example

query {
  inventory {
    version
    date
  }
  picking {
    version
    date
  }
}

Monitoring Best Practices

1. Regular Health Checks: Set up automated queries to monitor service availability

2. Version Tracking: Track version numbers across deployments

3. Alert Configuration: Configure alerts when services become unavailable

4. Dashboard Integration: Integrate status queries into monitoring dashboards

See Also

• ServiceInfo Type - Details about the ServiceInfo return type