Sentry和Jenkins的使用

末蓝、 2022-12-22 06:29 156阅读 0赞

# Sentry #

需要异常捕获、追踪，跟踪整个处理过程，统计分析并可视化展示异常相关数据。

堆栈跟踪、堆栈本地信息、前面的事件、可能导致问题的提交以及在错误发生时捕获的定制数据

Sentry分为`服务平台`和`客户端`两个部分，这是针对于sentry整个处理流程来说。客户端产生异常并上报异常，服务平台负责处理存储、分类、处理、分析、跟踪、展示。

![bbaeeeb535486e19155d17b742a9d114.png][]

`Sentry`的服务端分为`web`、`cron`、`worker`这几个部分，应用（客户端）发生错误后将错误信息上报给`web`，`web`处理后放入`消息队列`或`Redis内存队列`，`worker`从队列中取出数据进行处理

客户端

{ 
      "@sentry/browser": "^5.7.1",
      "@sentry/integrations": "^5.7.1",
    }

![24f6e432c4cf367acc8c54ec4f0b61a0.png][]

服务平台可以使用官方，也可以使用私有化部署，客户端也就是SDK，对于前端项目就是安装npm插件包

## 使用 ##

### 接入 ###

![新建项目][672911f05631c62cc353468108ee24d3.png]

新建一个项目，根据根据项目类型选择

![Sentry支持的类型][Sentry]

在代码里面安装：

如果是Vue，可以在main.js里面添加，

import Vue from 'vue'
    import * as Sentry from '@sentry/browser';
    import * as Integrations from '@sentry/integrations';
    
    Sentry.init({ 
      dsn: 'http://59aec82d2ad74418846d17e3a85bf081:4f1faacb1ca54ba98b11c8225ac9865b@101.37.148.124:9000/13',
      integrations: [new Integrations.Vue({ Vue, attachProps: true})],
    });

或者用CDN的方式引入：

<script src="https://browser.sentry-cdn.com/5.5.0/bundle.min.js" crossorigin="anonymous"></script>
    
    
    <script src="https://browser.sentry-cdn.com/5.5.0/vue.min.js" crossorigin="anonymous"></script>
    
    <script>
      Sentry.init({ 
        dsn: 'http://59aec82d2ad74418846d17e3a85bf081:4f1faacb1ca54ba98b11c8225ac9865b@101.37.148.124:9000/13',
        integrations: [new Sentry.Integrations.Vue({ Vue, attachProps: true})],
      });
    </script>

其中，`DSN`的获取：

![选择设置][5098694ea7c223246ff176df89f51ed0.png]

进入项目的设置页面，找到图中所示的`DSN`，替换掉上面代码块里的就可以了。

界面介绍：

### 基本SDK配置 ###

### SourceMap添加 ###

安装`Sentry`对应的命令行管理工具`sentry-cli`：

`cnpm i -g @sentry/cli`

生成`token`

选择账户下的`API Keys`，选择生成一个新的`Token`

![0b31416a104548c44a1d7d883a61a733.png][]

勾选上响应的权限

![e46fa13cde70e24511b78f2761b2d78a.png][]

命令行登录：

`sentry-cli --url http://101.37.148.124:9000/ login`

![7aeb9c0297a868843b42f6aca886cc12.png][]

输入`Token`即可

输入`sentry-cli releases -o 组织名 -p 项目名 new staging@1.0.1`，为项目打上`Release`

![6be460fd4f05cacadbe3e0478770fe15.png][]

这里的 `staging@1.0.1` 就是我们指定的版本号. `-o -p`可以通过页面左上角可以看到。现在我们可以通过创建多个版本号来进行异常分类。同时，也可以通过页面中`Releases`查看是否创建成功。

![dba477a665c413c71ba1e3503f492ebd.png][]

### Issue关联GitLab ###

[相关01][01]

[相关02][02]

--------------------

# Jenkins #

Jenkins通过和其他`CI(Continuous Integration)`持续集成工具一样的`Pipeline`管道的概念，通过将一个任务线看做一个管道，管道分为了很多个步骤，每个步骤是单独的一个小任务，可以通过Jenkins自带的或者安装的插件来执行每一步，每个小步骤，相互配合，相互嵌套，由`Jenkins`统一管理调配，共同完成完整的一条流水线。

比如我们通常的项目开发完成后，上线部署可以看做是一条流水线，一个`Pipeline`，连接服务器，进入目录，备份旧版本，上传新版本，这些都可以看做一个小任务，在Jenkins里可以当做一个一个的`Step`执行。

### 项目未配置Jenkins ###

如果是新项目，需要告诉运维：

1.  没有Jenkins账号，先向运维申请账号。
2.  项目属于哪个开发组（便于分配权限）
3.  需要部署到的服务器是哪个（需要做免密登录，传输代码）
4.  需要部署到哪个目录
5.  代码仓库地址`.git`、需要做`Jenkins`的仓库分支
6.  项目`build`需要执行的命令（`(c)npm install` 、 `npm run build`）
7.  项目`build`需要安装的环境（`Node.js`是否有版本要求、`npm`版本要求等，特殊情况）
8.  执行结果推送方式（钉钉机器人、email）

## 自动化构建流程 ##

整个构建过程，如何执行的？

公司项目编译构建过程是通过`Jenkins手动触发构建`，每次项目上线，想要进行构建，需要：

1.  登录`Jenkins`，进入到相关项目下面，配置构建参数，手动触发构建
2.  此时，根据配置的分支参数，直接使用`git`去拉取远程仓库中对应分支的最新代码
3.  拉取到本地中之后，进入项目文件目录，执行安装依赖，`build`源码文件
4.  进入旧版本目录，复制一份，压缩一下，做个备份，将备份放到指定目录，删除旧版本。
5.  将上面`build`好的文件移动到相关目录中（Nginx映射的Web目录或者其他），使用新版本替换旧版本。
6.  整个流程执行完成，通过`WebHook`推送到钉钉，钉钉推送执行结果。

![Jenkins基本构建过程][Jenkins]

--------------------

## 自己配置一个Jenkins构建 ##

Jenkins的安装没有什么难度，官网或者网上都有教程，一步一步来，出错排错就可以。

`以Hexo配合Jenkins部署为例`

需求：`Hexo`写的，需要达到的效果：每次写好的md文件，推送到`git`仓库（码云），Jenkins自动拉取代码，自动编译成`html`，替换旧版本，获取钉钉通知。

属于`git push`自动触发，协作项目中，如果区分了`正式分支`和`开发分支`，可以设置当开发分支合并到正式分支的时候触发。

### gitee配置 ###

#### 安装插件 ####

在`Jenkins`中选择`Manage Jenkins -> Manage Plugins -> Available`，搜索框直接搜索`Gitee`

![92a83e32c664a0216ad0ca80e1792b9c.png][]

#### 添加码云链接配置 ####

1.  前往 `Jenkins -> Manage Jenkins -> Configure System -> Gitee Configuration -> Gitee connections`
2.  在 `Connection name` 中输入 `Gitee` 或者你想要的名字
3.  Gitee host URL 中输入码云完整 URL地址： `https://gitee.com` （码云私有化客户输入部署的域名）  
    `Credentials` 中如还未配置码云`APIV5`私人令牌，点击 `Add - > Jenkins`
4.  `Domain` 选择 `Global credentials`
5.  `Kind` 选择 `Gitee API Token`
6.  `Scope` 选择你需要的范围
7.  `Gitee API Token` 输入你的码云私人令牌，获取地址：https://gitee.com/profile/personal\_access\_tokens
8.  `ID`, `Descripiton` 中输入你想要的 `ID` 和描述即可。
9.  `Credentials` 选择配置好的 `Gitee APIV5 Token`
10. 点击 `Advanced` ，可配置`是否忽略 SSL 错误（适您的Jenkins环境是否支持）`，并可设置`链接测超时时间（适您的网络环境而定）`
11. 点击 `Test Connection` 测试链接是否成功，如失败请检查以上 3，5，6 步骤。

![e198e6e204db98f3c848a6046a3c7564.png][]

### 项目配置 ###

1.  创建一个Jenkins流水线，有几种形式可供选择

![31ba771393ff2d052b55599cf25e8e21.png][]

*  `Freestyle project`:自由形式项目，任何不属于下面的项目都可以选择这个，自定义程度较高

![16fe348ae55c7511ebc276c5e4f82fb2.png][]

*  `Pipeline`:管道

![9ba6638a4a1833628fe9d78b30b0daad.png][]

*  `Multi-configuration project`:多种配置

![b2ee77e97660a4f78b1a3bc1c547ea6f.png][]

*  `Folder`:文件夹

![16f536f0a92bceb17ed930466a1699a8.png][]

*  `GitHub Organization`:

![56dd39337ffe5a490e45a1aa8b937f4c.png][]

*  `Multibranch Pipeline`:

![39f888f1a81e637d1329f2c5d9943cde.png][]

这些形式没有本质区别，都是流水线性质，只是根据不同形式的项目会有不同的推荐的常用步骤。

日常的项目`build`可以选择第一种，`Freestyle project`自由形式的项目。

这种流水线有6个推荐的`Step`：

*  `General`：通用（该条流水线的描述、远程仓库的连接、关于构建和仓库的基础配置）
 *  `Source Code Management`：源代码管理（从哪里拉取代码，哪个分支，也支持`SVN`）
 *  `Build Triggers`：构建触发器（什么情况下会触发构建过程开始启动）
 *  `Build Environment`：构建环境（`build`之前要准备哪些，密钥传输、清空jenkins工作空间，一般情况下没有特殊需求可以不用管）
 *  `Build`：构建（主要的构建过程，通过配置一些待执行shell命令，达到移动文件，执行构建的目的。命令直接写shell，平时在ssh工具终端中怎么写，就怎么写）
 *  `Post-build Actions`：构建后操作（构建成功，执行哪些操作，消息推送、给远程仓库打标签等等后续操作）

1.  选择已经配置好的Gitee账户链接，配置之后可以访问账户之下的所有仓库

![2d61b99be11bd2ca7d31dade20b9d76a.png][]

1.  选择要拉取代码的仓库地址，分支

![7fe639bc745ebaeccda333f1b505e890.png][]

1.  配置触发器（什么情况下开启构建流程）

![83ce568a0891c91892a9a35b5fd4bd1f.png][]

1.  配置构建环境，没有特殊要求可以不管

![c93b7d60ad0e0ac0e735e72dd0d411f0.png][]

1.  配置整个构建过程执行的`shell脚本`，注意如果一个程序分两段`shell`，需要使用`export BUILD_ID=DONTKILLME`留活，不然Jenkins会在一段脚本之后杀死程序，如图，我需要scp在传输文件之后接着执行第二段脚本，那就需要在第一段的后面加上这条命令，告诉Jenkins，不要杀死我。

![85cccf01faf64fed0fbee11e75797ad0.png][]

1.  构建过程执行完之后要做的操作，配合不同的插件，可以执行不同的后续操作。

### 添加钉钉机器人通知 ###

![8fab343e7f2b805e5d3c1af381cdd26a.png][]

群助手选择添加一个自定义机器人

![23f5dca1e2064d13e7dbab3d83379f24.png][]

填写安全设置可以使用`自定义关键词`，定义的关键词必须在推送的时候包含该关键词。也可以使用`IP地址`，将Jenkins服务器IP加进去，或者使用签名推送。

![52d957a2419289024c3e3e6ca558ea4b.png][]

#### 更多功能，更多插件 ####

`Sonar`集成，安装`SonarQube Scanner for Jenkins`，`Jenkins`只是一个`构建流程控制工具`，具体怎么玩，看具体需求。

https://gitee.com/help/articles/4193\#article-header6

[bbaeeeb535486e19155d17b742a9d114.png]: /images/20221120/a60863f181124c139b299b73893d6cf3.png
[24f6e432c4cf367acc8c54ec4f0b61a0.png]: /images/20221120/cc37cbff04ca4f138d0e2096da4d218a.png
[672911f05631c62cc353468108ee24d3.png]: /images/20221120/aa03948a269f4ea18a7c98a82a5a7fc4.png
[Sentry]: /images/20221120/d25cb4790f694ed5abc7fec37e888a97.png
[5098694ea7c223246ff176df89f51ed0.png]: /images/20221120/4ed76026dda34035bc3b1ac18f3e2bfd.png
[0b31416a104548c44a1d7d883a61a733.png]: /images/20221120/cea890196fc54e1e86f40bb8db4835c6.png
[e46fa13cde70e24511b78f2761b2d78a.png]: /images/20221120/32b49dae3168415c8cb25b45a99b0827.png
[7aeb9c0297a868843b42f6aca886cc12.png]: /images/20221120/e591e66527004dea89ce183d9c1f1539.png
[6be460fd4f05cacadbe3e0478770fe15.png]: /images/20221120/99891c7895f54b21b1419a236d604d47.png
[dba477a665c413c71ba1e3503f492ebd.png]: /images/20221120/7425ec6b634b49039930bb88c7939802.png
[01]: https://blog.csdn.net/m18510011124/article/details/80935343
[02]: https://juejin.im/post/5cc2b8b9e51d456e40377319
[Jenkins]: /images/20221120/4d56c2fd3a8847f992d7102bf719c0aa.png
[92a83e32c664a0216ad0ca80e1792b9c.png]: /images/20221120/7aabd9cca146473881e924d692b937f9.png
[e198e6e204db98f3c848a6046a3c7564.png]: /images/20221120/6885d213f995434494c8773b0f36c2e8.png
[31ba771393ff2d052b55599cf25e8e21.png]: /images/20221120/303f4cb375f848eda0a423ea66cfc91b.png
[16fe348ae55c7511ebc276c5e4f82fb2.png]: /images/20221120/2023880d7d5847aca2481e318a2d0ee1.png
[9ba6638a4a1833628fe9d78b30b0daad.png]: /images/20221120/002e8d39459741058eb89eb34566dfaf.png
[b2ee77e97660a4f78b1a3bc1c547ea6f.png]: /images/20221120/80425fc0ef474e12b4b53060a969e6fe.png
[16f536f0a92bceb17ed930466a1699a8.png]: /images/20221120/111f192624ab4eaebd8ef7caba1bf89e.png
[56dd39337ffe5a490e45a1aa8b937f4c.png]: /images/20221120/f84370d46f5d4477bad7b17a0f91babf.png
[39f888f1a81e637d1329f2c5d9943cde.png]: /images/20221120/fc25d2dcd15640e08067100ebafbf44c.png
[2d61b99be11bd2ca7d31dade20b9d76a.png]: /images/20221120/67277630a5a549f1ac0e019b7f39cfc0.png
[7fe639bc745ebaeccda333f1b505e890.png]: /images/20221120/e1e65a2206f44bc1873137d9966c70a9.png
[83ce568a0891c91892a9a35b5fd4bd1f.png]: /images/20221120/47ede7d112ed498da955224c7935e84d.png
[c93b7d60ad0e0ac0e735e72dd0d411f0.png]: /images/20221120/32a53228bf6f45c693955fa17ad2351b.png
[85cccf01faf64fed0fbee11e75797ad0.png]: /images/20221120/710d29920f3a46349b3445e3effceed9.png
[8fab343e7f2b805e5d3c1af381cdd26a.png]: /images/20221120/8c3afb2576184c26b7a0068a3bed0067.png
[23f5dca1e2064d13e7dbab3d83379f24.png]: /images/20221120/2ec3eda3c3ee4955b5d2807861044396.png
[52d957a2419289024c3e3e6ca558ea4b.png]: /images/20221120/bfa051a82b574055b5972a4b271bd076.png