Skip to content
Permalink
Browse files
Merge pull request #299 from hailin0/sky-1.3.6-prepare
Add skywalking agent deployment docs
  • Loading branch information
chengshiwen committed Apr 28, 2021
2 parents d59470f + 4f664e6 commit 7e5ab571faeee037bce4035fad3a5ef2c0771699
Showing 4 changed files with 122 additions and 0 deletions.
@@ -0,0 +1,57 @@

dolphinscheduler-skywalking
=============================

The dolphinscheduler-skywalking module provides [Skywalking](https://skywalking.apache.org/) monitor agent for the Dolphinscheduler project.

This document describes how to enable Skywalking 8.4+ support with this module.

# Installation

The following configuration is used to enable Skywalking agent.

### Through environment variable configuration (for Docker)

```shell
docker run -d --name dolphinscheduler \
-e SKYWALKING_ENABLE=true \
-e SW_AGENT_COLLECTOR_BACKEND_SERVICES="your.skywalking-oap-server.com:11800" \
-e SW_GRPC_LOG_SERVER_HOST="your.skywalking-log-reporter.com" \
-e SW_GRPC_LOG_SERVER_PORT="11800"
...
apache/dolphinscheduler:latest all
```

### Through install_config.conf configuration (for Dolphinscheduler install.sh)

Add the following configurations to `${workDir}/conf/config/install_config.conf`.

```properties
# skywalking config
# note: enable skywalking tracking plugin
enableSkywalking="true"
# note: configure skywalking backend service address
skywalkingServers="your.skywalking-oap-server.com:11800"
# note: configure skywalking log reporter host
skywalkingLogReporterHost="your.skywalking-log-reporter.com"
# note: configure skywalking log reporter port
skywalkingLogReporterPort="11800"
```

# Usage

### Import dashboard

#### Import dolphinscheduler dashboard to skywalking sever

Copy the `${dolphinscheduler.home}/skywalking-agent/dashboard/dolphinscheduler.yml` file into `${skywalking-oap-server.home}/config/ui-initialized-templates/` directory, and restart Skywalking oap-server.

#### View dolphinscheduler dashboard

If you have opened Skywalking dashboard with a browser before, you need to clear browser cache.

![img1](/img/skywalking/import-dashboard-1.jpg)
@@ -0,0 +1,57 @@

dolphinscheduler-skywalking
=============================

dolphinscheduler-skywalking 模块为 Dolphinscheduler 项目提供了 [Skywalking](https://skywalking.apache.org/) 监控代理。

本文档介绍了如何通过此模块接入 Skywalking 8.4+。

# 安装

以下配置用于启用 Skywalking agent。

### 通过配置环境变量 (使用 Docker 部署时)

```shell
docker run -d --name dolphinscheduler \
-e SKYWALKING_ENABLE=true \
-e SW_AGENT_COLLECTOR_BACKEND_SERVICES="your.skywalking-oap-server.com:11800" \
-e SW_GRPC_LOG_SERVER_HOST="your.skywalking-log-reporter.com" \
-e SW_GRPC_LOG_SERVER_PORT="11800"
...
apache/dolphinscheduler:latest all
```

### 通过配置 install_config.conf (使用 Dolphinscheduler install.sh 部署时)

添加以下配置到 `${workDir}/conf/config/install_config.conf`.

```properties
# skywalking config
# note: enable skywalking tracking plugin
enableSkywalking="true"
# note: configure skywalking backend service address
skywalkingServers="your.skywalking-oap-server.com:11800"
# note: configure skywalking log reporter host
skywalkingLogReporterHost="your.skywalking-log-reporter.com"
# note: configure skywalking log reporter port
skywalkingLogReporterPort="11800"
```

# 使用

### 导入图表

#### 导入图表到 Skywalking server

复制 `${dolphinscheduler.home}/skywalking-agent/dashboard/dolphinscheduler.yml` 文件到 `${skywalking-oap-server.home}/config/ui-initialized-templates/` 目录下,并重启 Skywalking oap-server。

#### 查看 dolphinscheduler 图表

如果之前已经使用浏览器打开过 Skywalking,则需要清空浏览器缓存。

![img1](/img/skywalking/import-dashboard-1.jpg)
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
@@ -24,6 +24,10 @@ export default {
title: 'Kubernetes Deployment',
link: '/en-us/docs/1.3.5/user_doc/kubernetes-deployment.html',
},
{
title: 'Skywalking-Agent Deployment',
link: '/en-us/docs/1.3.5/user_doc/skywalking-agent-deployment.html',
},
],
},
{
@@ -123,6 +127,10 @@ export default {
title: 'Kubernetes部署(Kubernetes)',
link: '/zh-cn/docs/1.3.5/user_doc/kubernetes-deployment.html',
},
{
title: 'Skywalking-Agent部署(Skywalking)',
link: '/zh-cn/docs/1.3.5/user_doc/skywalking-agent-deployment.html',
},
],
},
{

0 comments on commit 7e5ab57

Please sign in to comment.