# docker-screeps-grafana

**Repository Path**: zxfbugprogrammer/docker-screeps-grafana

## Basic Information

- **Project Name**: docker-screeps-grafana
- **Description**: 基于Docker、Grafana的Screeps监控图表服务
- **Primary Language**: Docker
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-03-31
- **Last Updated**: 2025-07-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# docker-screeps-grafana
## 简介

本项目是在[Screeper]([screepers · GitHub](https://github.com/screepers))的开源项目[screeps-grafana]([GitHub - screepers/screeps-grafana: Pretty graphs for screeps](https://github.com/screepers/screeps-grafana))的基础上进行修改、基于Docker、Graphite、Grafana的Screeps监控服务。

## 准备

本项目读取Screeps的Memory信息，完成对Screeps状态的监控。所以需要把准备监控的信息统计、存储到Memory中。

可使用本项目中的`stats.js`，将文件中的函数在主循环末尾调用，即可完成信息统计。

## 部署（以Ubuntu为例）

### 1. 安装Docker、Docker Compose

```shell
# 使用国内源一键安装Docker
curl -sSL https://get.daocloud.io/docker | sh

# Docker Compose发布在GitHub，国内下载相对较慢，所以采用国内镜像安装
curl -L https://get.daocloud.io/docker/compose/releases/download/1.28.6/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
```

### 2.克隆本项目到本地

``` shell
git clone https://gitee.com/zxfbugprogrammer/docker-screeps-grafana.git
```

### 3.填写Screeps的相关信息

```shell
# 复制screeps-crawler.env.example 命名为 screeps-crawler.env
cp screeps-crawler.env.example screeps-crawler.env
```

修改screeps-crawler.env中的相关信息（各字段具体含义见文件中注释）

### 4.运行项目

注：在构建运行容器前，可通过修改项目目录下的.env文件，来修改Grafana服务所在的端口（默认端口为1337）

```shell
# cd 到本项目所在文件夹
cd docker-screeps-grafana/

# 构建并后台运行容器
docker-compose up -d --build
```

### 5.添加默认数据库

```shell
# cd 到本项目所在文件夹
cd docker-screeps-grafana/

# 添加默认数据库，以端口1337为例
curl -s 'http://admin:admin@localhost:1337/api/datasources' -X POST -H 'Content-Type: application/json;charset=UTF-8' --data-binary '{"name":"localGraphite","type":"graphite","url":"http://graphite-stats","access":"proxy","isDefault":true,"database":""}' > /dev/null
```

### 6.添加默认图表（可选，需配合本项目stats.js使用）

1、访问`您的IP:1337(或您修改后的端口号)`，登录账号。**注意：初始账号密码均为admin**

**若为云服务器，注意放开服务器端口**

用初始账号密码登录会提示更改密码，按照提示操作即可。

2、登陆完成后，按照下图所示，点击Import选项

![](./pic/1.png)

3、点击Upload JSON file

![](./pic/2.png)

4、点击Import按钮

![](./pic/3.png)

## 使用

访问`您的IP:1337(或您修改后的端口号)`，登录账号。**注意：初始账号密码均为admin**

**若为云服务器，注意放开服务器端口**

用初始账号密码登录会提示更改密码，按照提示操作即可。

## 配置

您可以修改项目文件夹下的`conf/storage-schemas.conf`配置Graphite

您可以修改项目文件夹下的`conf/tcp.js  conf/udp.js`配置stats

您可以修改项目文件夹下的`screeps-crawler-src/index.js`定制Screeps数据获取脚本

若您还没有运行项目，请按照部署中的过程进行

若您已经启动项目，则运行如下命令，重启并重新构建镜像

```shell
docker-compose down && docker-compose up -d --build
```

## 删除

依次运行如下命令

```shell
# cd 到本项目所在文件夹
cd docker-screeps-grafana/

# 删除容器并删除数据卷 若您不想删除储存的数据，请去掉-v参数
docker-compose down -v

# 清理无效volume
docker volume prune

# 清理无效镜像
docker image prune

# 删除本项目安装的镜像
# 请自行使用 docker images 、 docker image rm 等命令删除
```