Sentry

2017-03-10

安装Sentry

推荐用docker来安装，参考https://hub.docker.com/_/sentry/

docker pull sentry
docker pull redis
docker pull postgres

运行redis

docker run -d --name sentry-redis redis

运行progress

docker run -d --name sentry-postgres -e POSTGRES_PASSWORD=secret -e POSTGRES_USER=sentry postgres

使用sentry命令行生成一个密钥，用于在sentry容器之间授权

king@king:~$ docker run --rm sentry config generate-secret-key
fc=k^xur0()hb7cqi81z@&b!d9cy6l_-j#&36)kk28u^%ldx*l

如果数据库是第一次使用（新的），用下面的命令创建表结构（初始化）

docker run -it --rm -e SENTRY_SECRET_KEY='<secret-key>' \
	--link sentry-postgres:postgres --link sentry-redis:redis sentry upgrade

在这个过程中会提示创建用户

Would you like to create a user account now? [Y/n]: Y
Email: email@gmail.com
Password:
Repeat for confirmation: 
Should this user be a superuser? [y/N]: Y
User created: email@gmail.com

运行服务器（Web）

注意-p 8080:9000

docker run -d --name my-sentry -e SENTRY_SECRET_KEY='<secret-key>' \
	-p 8080:9000 \
	--link sentry-redis:redis --link sentry-postgres:postgres sentry

sentry还需要 celery beat 和 celery workers干活，所以再启动两个容器

docker run -d --name sentry-cron -e SENTRY_SECRET_KEY='<secret-key>' \
	--link sentry-postgres:postgres --link sentry-redis:redis sentry run cron
docker run -d --name sentry-worker-1 -e SENTRY_SECRET_KEY='<secret-key>'  \
	--link sentry-postgres:postgres --link sentry-redis:redis sentry run worker

Go Client

sentry client for go https://docs.sentry.io/clients/go/，只需要简单的封裝就可以适配gin

package main

import (
	"github.com/getsentry/raven-go"
	"net/http"
	"fmt"
	"github.com/gin-gonic/gin"
	"runtime/debug"
	"errors"
)

func Middleware(dsn string) gin.HandlerFunc {
	if dsn == "" {
		panic("Error: No DSN detected!\n")
	}
	raven.SetDSN(dsn)
	var client = raven.DefaultClient

	return func(c *gin.Context) {
		defer func() {
			if err := recover(); err != nil {

				flags := map[string]string{
					"endpoint": c.Request.RequestURI,
				}

				debug.PrintStack()
				rvalStr := fmt.Sprint(err)
				packet := raven.NewPacket(rvalStr, raven.NewException(
					errors.New(rvalStr),
					raven.NewStacktrace(2, 3, nil)),
				)
				client.Capture(packet, flags)
				c.Writer.WriteHeader(http.StatusInternalServerError)

				//const size = 1 << 12
				//buf := make([]byte, size)
				//n := runtime.Stack(buf, false)
				//client.CaptureMessage(fmt.Sprintf("%v\nStacktrace:\n%s", err, buf[:n]),nil)
				//c.Writer.WriteHeader(http.StatusInternalServerError)
			}
		}()
		c.Next()
	}
}

参考

package main

import (
	"github.com/gin-gonic/gin"
	"github.com/getsentry/raven-go"
	"errors"
	"fmt"
)

func main() {
	r := gin.Default()

	r.Use(Middleware("http://5138362834d22ecbd@localhost:8080/2"))
	// r.Use(gin.Recovery())

	r.GET("/ping", func(c *gin.Context) {
		raven.CaptureErrorAndWait(errors.New("this is a string error"), nil)
		panic(fmt.Sprintf("this is a panic"))
		c.JSON(200, gin.H{
			"message": "pong",
		})
	})
	r.Run(":12345")
}

Python client

# -*- coding: utf-8 -*-
from raven.contrib.flask import Sentry
from flask import Flask, session, redirect, url_for, escape, request
from flask_script import Manager

sentry = Sentry()

def create_app():
    app = Flask(__name__)
    sentry.init_app(app, dsn='http://5138362834d22ecbd@localhost:8080/2')
    return app

app = create_app()
sentry.captureMessage('hello, world!.shit');

Pip修改默认源

Pip默认的源速度很慢，而且时而访问不了，可以修改到国内的源

pip install -i http://pypi.douban.com/simple/ \
    --trusted-host pypi.douban.com itsdangerous

其他比如http://mirrors.aliyun.com/pypi/simple/

设置全局默认

king@KingUbuntu64:~$ mkdir -p ~/.config/pip/
king@KingUbuntu64:~$ vi ~/.config/pip/pip.conf

如果是Windows，路径是【%APPDATA%\pip\pip.ini】

[global]
timeout = 60
index-url = http://pypi.douban.com/simple
[install]
trusted-host=pypi.douban.com

不用docker

先准备redis，mysql或者postgres

安装sentry

apt-get 安装的依赖可能有所差异

apt-get install libpq-dev libffi-dev python-mysqldb libmysqlclient-dev \
	libssl-dev libjpeg9 libjpeg9-dev libpng16-16 libpng3 libpng16-dev
pip install sentry pymysql MySQL-python

生成初始化配置

(venv) king@kingqiu:~/proj$ sentry init .
(venv) king@kingqiu:~/proj$ ls
config.yml  sentry.conf.py

修改配置

数据库

默认是postgres

DATABASES = {
    'default': {
        'ENGINE': 'sentry.db.postgres',
        'NAME': 'sentry',
        'USER': 'postgres',
        'PASSWORD': '',
        'HOST': '',
        'PORT': '',
    }
}

改成mysql，其中的【NAME】表示数据库名，需要事先新建该数据库

DATABASES = {
    'default': {
        # You can swap out the engine for MySQL easily by changing this value
        # to ``django.db.backends.mysql`` or to PostgreSQL with
        # ``django.db.backends.postgresql_psycopg2``
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'sentry',
        'USER': 'username',
        'PASSWORD': 'password',
        'PORT': '3306',
        'HOST': 'localhost'
    }
}

Redis

# See https://docs.sentry.io/on-premise/server/queue/ for more
# information on configuring your queue broker and workers. Sentry relies
# on a Python framework called Celery to manage queues.

BROKER_URL = 'redis://localhost:6379'

IP/端口

SENTRY_WEB_HOST = '0.0.0.0'
SENTRY_WEB_PORT = 9000
SENTRY_WEB_OPTIONS = {
    # 'workers': 3,  # the number of web workers
    # 'protocol': 'uwsgi',  # Enable uwsgi protocol instead of http
}

运行

初始化

创建表神马的，config后面的.表示路径，自行修改。

在这个过程中，可以一次性创建超级用户

sentry --config=. upgrade

创建新用户

sentry --config=. createsuperuser
sentry --config=. createuser

启动

启动Web服务

sentry --config=. start

启动Wokers

sentry --config=. celery worker -B

使用OpenID登陆

在upgrade时，注册一个owner权限的用户，并且用此账户登陆

首次登陆会弹出Welcome to Sentry，其中Root URL会用作oauth回调路径，所以慎重填写

使用通用的OpenID登陆依赖一个sentry-auth-openid插件。

直接安装的sentry，按照指引即可，若使用docker，可以先调试确认

sudo docker run --rm -it --name my-sentry -e SENTRY_SECRET_KEY='$KEY' \
	-p 9000:9000 \
	--link sentry-redis:redis --link sentry-postgres:postgres sentry /bin/bash
# 安装插件
pip install https://github.com/TableflippersAnonymous/sentry-auth-openid/archive/master.zip
# 安装vi以便编辑配置
apt update && apt install vim -y

vi /etc/sentry/sentry.conf.py 添加以下内容

OPENID_AUTHORIZE_URL = "http://server:5556/dex/auth"
OPENID_TOKEN_URL = "http://server:5556/dex/token"
OPENID_CLIENT_ID = "example-app"
OPENID_CLIENT_SECRET = "ZXhhbXBsZS1hcHAtc2VjcmV0"

openid服务器，可以用https://github.com/coreos/dex 测试用着

启用

登陆之后，左边菜单MANAGE -> Auth，完整的URL http://localhost:9000/organizations/sentry/auth/

然后点击OPENID 按钮会跳转到oidc服务器进行验证，验证OK保存，下次就自动开启了openid登陆

个人笔记