jupyter/nbviewer-statuspage

nbviewer状态页数据发布器 Docker镜像文档

镜像概述

本Docker镜像专为nbviewer服务设计，是一个状态页数据发布工具。其核心功能是获取GitHub API速率限制的剩余量，并将该数据自动发布到statuspage.io，帮助运维人员监控nbviewer服务依赖的GitHub API资源使用情况，确保服务稳定运行。

核心功能与特性

核心功能

• 自动采集GitHub API速率限制剩余量数据
• 将采集到的速率限制数据发布至statuspage.io状态页
• 支持定期数据更新，保持状态页信息实时性

特性

• 轻量级设计，资源占用低
• 与statuspage.io API无缝集成
• 专为nbviewer服务的GitHub API依赖场景优化
• 配置简单，通过环境变量即可完成参数设置

使用场景与适用范围

使用场景

• nbviewer服务运维监控：实时跟踪GitHub API速率限制使用情况，避免因API调用超限导致nbviewer服务中断
• 依赖GitHub API的nbviewer实例状态可视化：通过statuspage.io向用户或运维团队展示GitHub API资源状态
• 预防性监控：当GitHub API速率限制接近阈值时，可结合告警机制提前预警

适用范围

• 部署nbviewer服务的服务器环境
• 使用GitHub API获取资源的nbviewer实例
• 需要向statuspage.io发布监控指标的运维场景

使用方法与配置说明

环境变量配置

运行本镜像需配置以下环境变量：

Docker运行示例

基本运行命令

bash
docker run -d \
  -e GITHUB_TOKEN="your_github_token" \
  -e STATUSPAGE_API_KEY="your_statuspage_api_key" \
  -e STATUSPAGE_PAGE_ID="your_page_id" \
  -e STATUSPAGE_METRIC_ID="your_metric_id" \
  --name nbviewer-status-publisher \
  <镜像名称>

自定义更新间隔示例（每3分钟更新一次）

bash
docker run -d \
  -e GITHUB_TOKEN="your_github_token" \
  -e STATUSPAGE_API_KEY="your_statuspage_api_key" \
  -e STATUSPAGE_PAGE_ID="your_page_id" \
  -e STATUSPAGE_METRIC_ID="your_metric_id" \
  -e UPDATE_INTERVAL=180 \
  --name nbviewer-status-publisher \
  <镜像名称>

Docker Compose配置示例

yaml
version: '3'
services:
  nbviewer-status-publisher:
    image: <镜像名称>
    environment:
      - GITHUB_TOKEN=your_github_token
      - STATUSPAGE_API_KEY=your_statuspage_api_key
      - STATUSPAGE_PAGE_ID=your_page_id
      - STATUSPAGE_METRIC_ID=your_metric_id
      - UPDATE_INTERVAL=300
    restart: unless-stopped

注意事项

• 确保提供的GitHub令牌具有足够权限获取速率限制数据（无需额外权限，基础令牌即可）
• statuspage.io的API密钥需具备编辑指标的权限
• 合理设置更新间隔，避免因频繁请求对GitHub API或statuspage.io API造成不必要的压力
• 监控环境变量配置的正确性，错误的配置可能导致数据发布失败