opbeans/opbeans-node

Opbeans for Node.js

镜像概述

Opbeans库存管理系统是由Elastic创建并维护的演示应用，本镜像为其Node.js实现版本，主要用于展示Elastic APM（应用性能监控）功能。


技术栈

该应用使用以下技术：

• Node.js
• Express
• PostgreSQL
• Redis
• https://***.github.io/react/（通过https://github.com/elastic/opbeans-frontend）
• https://github.com/ReactTraining/react-router%EF%BC%88%E9%80%9A%E8%BF%87%5Bopbeans-frontend%5D%EF%BC%89
• https://github.com/reactjs/redux%EF%BC%88%E9%80%9A%E8%BF%87%5Bopbeans-frontend%5D%EF%BC%89
• Elastic APM

配置说明

需设置以下环境变量：

• NODE_ENV - Node环境（设为production以启用Elastic APM）
• PORT - Opbeans服务器运行端口（默认：3000）
• PGHOST - PostgreSQL服务器主机
• PGPORT - PostgreSQL服务器端口
• PGUSER - PostgreSQL数据库用户名
• PGPASSWORD - PostgreSQL数据库密码
• PGDATABASE - PostgreSQL数据库名称（默认：opbeans）
• ELASTIC_APM_SERVICE_NAME - 服务器应用的Elastic APM服务名称（默认：opbeans-node）
• ELASTIC_APM_SERVER_URL - APM服务器URL（默认：http://localhost:8200）
• ELASTIC_APM_JS_SERVER_URL - 客户端应用的Elastic APM服务器URL（默认：http://localhost:3000）
• ELASTIC_APM_JS_SERVICE_NAME - 客户端应用的Elastic APM应用名称（默认：https://github.com/elastic/opbeans-frontend/blob/master/package.json%E4%B8%AD%E7%9A%84%60name%60%E5%AD%97%E6%AE%B5%EF%BC%89
• ELASTIC_APM_JS_SERVICE_VERSION - 客户端应用的Elastic APM应用版本（默认：https://github.com/elastic/opbeans-frontend/blob/master/package.json%E4%B8%AD%E7%9A%84%60version%60%E5%AD%97%E6%AE%B5%EF%BC%89

完整的Elastic APM代理环境变量列表参见官方文档。
完整的PostgreSQL环境变量列表参见官方文档。

数据库引导

初始化数据库表结构和基础数据：

bash
npm run db-setup

生成随机订单：

bash
node db/generate_orders.js <num>

其中<num>为要创建的订单数量。

启动应用

bash
npm start

更新客户端

若NODE_ENV非production，执行npm install时会自动克隆、安装并构建https://github.com/elastic/opbeans-frontend。如需更新opbeans-frontend，运行：

bash
npm run client-update

本地测试

最简单的测试方式：

bash
make test

测试基于https://github.com/sstephenson/bats%E7%BC%96%E5%86%99%EF%BC%8C%E4%BD%8D%E4%BA%8E%60tests%60%E7%9B%AE%E5%BD%95%E4%B8%8B%E3%80%82

本地发布Docker镜像

发布Docker镜像：

bash
VERSION=1.2.3 make publish

注意：VERSION指将发布到仓库的Docker镜像标签。

演示说明

触发错误

访问路径/is-it-coffee-time可触发应用内置错误。

触发缓慢

应用提供两个添加客户的npm脚本：

• customer-add-ok - 正常添加新客户
• customer-add-redos - 添加客户失败，同时阻塞服务器处理其他请求

通过以下命令运行：

bash
npm run <name>

若在Docker环境中运行，可使用docker-compose：

bash
docker-compose exec opbeans-node npm run customer-add-redos

Docker部署示例

docker-compose配置

yaml
version: '3'
services:
  opbeans-node:
    image: elastic/opbeans-node:latest
    ports:
      - "3000:3000"
    environment:
      - NODE_ENV=production
      - PGHOST=postgres
      - PGUSER=postgres
      - PGPASSWORD=postgres
      - PGDATABASE=opbeans
      - ELASTIC_APM_SERVER_URL=http://apm-server:8200
    depends_on:
      - postgres
      - redis
      - apm-server

  postgres:
    image: postgres:9.5
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
      - POSTGRES_DB=opbeans
    volumes:
      - postgres-data:/var/lib/postgresql/data

  redis:
    image: redis:alpine

  apm-server:
    image: docker.elastic.co/apm/apm-server:latest
    environment:
      - output.elasticsearch.enabled=false
      - apm-server.host=0.0.0.0:8200

volumes:
  postgres-data:

启动命令

bash
docker-compose up -d
# 初始化数据库
docker-compose exec opbeans-node npm run db-setup
# 生成100个测试订单
docker-compose exec opbeans-node node db/generate_orders.js 100

许可证

MIT