[ISSUE-13] add workflowDesc parameter for creating workflow

qiniu · Jul 6, 2018 · 31e4ccd · 31e4ccd
1 parent 582429c
commit 31e4ccd
Show file tree

Hide file tree

Showing 13 changed files with 47 additions and 21 deletions.
diff --git a/docs/3.配置参数详解.md b/docs/3.配置参数详解.md
@@ -9,6 +9,7 @@
 |参数名|描述|
 |---|---|
 |workflowName|工作流的名称|
+|workflowDesc|工作流的描述|
 |pipelineRepo|消息队列的名称|
 |logdbRepo|日志分析数据仓库的名称|
 |accessKey|账号的 AccessKey|

diff --git a/log4j/src/main/java/com/qiniu/appender/Log4jQiniuAppender.java b/log4j/src/main/java/com/qiniu/appender/Log4jQiniuAppender.java
@@ -37,6 +37,7 @@ public class Log4jQiniuAppender extends AppenderSkeleton implements Configs {
     private String pipelineHost;
     private String logdbHost;
     private String workflowName;
+    private String workflowDesc;
     private String workflowRegion;
     private String pipelineRepo;
     private String logdbRepo;
@@ -85,6 +86,14 @@ public void setWorkflowName(String workflowName) {
         this.workflowName = workflowName;
     }
 
+    public String getWorkflowDesc() {
+        return workflowDesc;
+    }
+
+    public void setWorkflowDesc(String workflowDesc) {
+        this.workflowDesc = workflowDesc;
+    }
+
     public String getWorkflowRegion() {
         return workflowRegion;
     }
@@ -320,7 +329,7 @@ public void activateOptions() {
         //try to create appender workflow
         try {
             QiniuAppenderClient.createAppenderWorkflow(pushPandoraClient, pipelineHost, logdbHost, workflowName,
-                    workflowRegion, pipelineRepo, logdbRepo, logdbRetention);
+                    workflowDesc, workflowRegion, pipelineRepo, logdbRepo, logdbRetention);
         } catch (Exception e) {
             e.printStackTrace();
             //@TODO better handle?

diff --git a/log4j/src/main/java/com/qiniu/appender/QiniuAppenderClient.java b/log4j/src/main/java/com/qiniu/appender/QiniuAppenderClient.java
@@ -20,17 +20,18 @@ public class QiniuAppenderClient implements ValueType, Analyzer, ExportWhence, W
      * Create appender workflow
      *
      * @param client         pandora client
-     * @param pipelineHost   pipeline host
-     * @param logdbHost      logdb host
+     * @param pipelineHost   pandora pipeline host
+     * @param logdbHost      pandora logdb host
      * @param workflowName   pandora workflow name
+     * @param workflowDesc   pandora workflow description
      * @param workflowRegion pandora workflow region
      * @param pipelineRepo   pandora pipeline repo name
      * @param logdbRepo      pandora logdb repo name
      * @param logdbRetention pandora logdb retention days
      */
     public static void createAppenderWorkflow(PandoraClient client, String pipelineHost, String logdbHost,
-                                              String workflowName, String workflowRegion, String pipelineRepo,
-                                              String logdbRepo, String logdbRetention)
+                                              String workflowName, String workflowDesc, String workflowRegion,
+                                              String pipelineRepo, String logdbRepo, String logdbRetention)
             throws Exception {
         PipelineClient pipelineClient = null;
         if (pipelineHost != null && !pipelineHost.isEmpty()) {
@@ -50,6 +51,7 @@ public static void createAppenderWorkflow(PandoraClient client, String pipelineH
         if (!pipelineClient.workflowExists(workflowName)) {
             CreateWorkflowInput createWorkflowInput = new CreateWorkflowInput();
             createWorkflowInput.workflowName = workflowName;
+            createWorkflowInput.comment = workflowDesc;
             createWorkflowInput.region = workflowRegion;
             pipelineClient.createWorkflow(createWorkflowInput);
         }

diff --git a/log4j/src/test/resources/log4j-template.properties b/log4j/src/test/resources/log4j-template.properties
@@ -4,6 +4,7 @@ log4j.appender.qiniu = com.qiniu.appender.Log4jQiniuAppender
 
 # change by yourself
 log4j.appender.qiniu.workflowName = logdemo1
+log4j.appender.qiniu.workflowDesc = log demo 1
 log4j.appender.qiniu.pipelineRepo = logpipe1
 log4j.appender.qiniu.logdbRepo = logdb1
 log4j.appender.qiniu.accessKey = ak

diff --git a/log4j/src/test/resources/log4j-template.xml b/log4j/src/test/resources/log4j-template.xml
@@ -5,6 +5,7 @@
         <param name="pipelineHost" value="https://pipeline.qiniu.com"/>
         <param name="logdbHost" value="https://logdb.qiniu.com"/>
         <param name="workflowName" value="logdemo1"/>
+        <param name="workflowDesc" value="log demo 1"/>
         <param name="workflowRegion" value="nb"/>
         <param name="pipelineRepo" value="logpipe1"/>
         <param name="logdbRepo" value="logdb1"/>

diff --git a/log4j2/src/main/java/com/qiniu/appender/Log4j2QiniuAppender.java b/log4j2/src/main/java/com/qiniu/appender/Log4j2QiniuAppender.java
@@ -240,6 +240,7 @@ public static Log4j2QiniuAppender createAppender(@PluginAttribute("name") String
                                                      @PluginAttribute("pipelineHost") String pipelineHost,
                                                      @PluginAttribute("logdbHost") String logdbHost,
                                                      @PluginAttribute("workflowName") String workflowName,
+                                                     @PluginAttribute("workflowDesc") String workflowDesc,
                                                      @PluginAttribute("workflowRegion") String workflowRegion,
                                                      @PluginAttribute("pipelineRepo") String pipelineRepo,
                                                      @PluginAttribute("logdbRepo") String logdbRepo,
@@ -275,8 +276,8 @@ public static Log4j2QiniuAppender createAppender(@PluginAttribute("name") String
 
         //try to create appender workflow
         try {
-            QiniuAppenderClient.createAppenderWorkflow(client, pipelineHost, logdbHost, workflowName, workflowRegion,
-                    pipelineRepo, logdbRepo, logdbRetention);
+            QiniuAppenderClient.createAppenderWorkflow(client, pipelineHost, logdbHost, workflowName, workflowDesc,
+                    workflowRegion, pipelineRepo, logdbRepo, logdbRetention);
         } catch (Exception e) {
             e.printStackTrace();
             return null;//logging appender initialization failed

diff --git a/log4j2/src/main/java/com/qiniu/appender/QiniuAppenderClient.java b/log4j2/src/main/java/com/qiniu/appender/QiniuAppenderClient.java
@@ -19,15 +19,18 @@ public class QiniuAppenderClient implements ValueType, Analyzer, ExportWhence, W
      * Create appender workflow
      *
      * @param client         pandora client
+     * @param pipelineHost   pandora pipeline host
+     * @param logdbHost      pandora logdb host
      * @param workflowName   pandora workflow name
+     * @param workflowDesc   pandora workflow description
      * @param workflowRegion pandora workflow region
      * @param pipelineRepo   pandora pipeline repo name
      * @param logdbRepo      pandora logdb repo name
      * @param logdbRetention pandora logdb retention days
      */
     public static void createAppenderWorkflow(PandoraClient client, String pipelineHost, String logdbHost,
-                                              String workflowName, String workflowRegion, String pipelineRepo,
-                                              String logdbRepo, String logdbRetention)
+                                              String workflowName, String workflowDesc, String workflowRegion,
+                                              String pipelineRepo, String logdbRepo, String logdbRetention)
             throws Exception {
         PipelineClient pipelineClient = null;
         if (pipelineHost != null && !pipelineHost.isEmpty()) {
@@ -47,6 +50,7 @@ public static void createAppenderWorkflow(PandoraClient client, String pipelineH
         if (!pipelineClient.workflowExists(workflowName)) {
             CreateWorkflowInput createWorkflowInput = new CreateWorkflowInput();
             createWorkflowInput.workflowName = workflowName;
+            createWorkflowInput.comment = workflowDesc;
             createWorkflowInput.region = workflowRegion;
             pipelineClient.createWorkflow(createWorkflowInput);
         }

diff --git a/log4j2/src/test/resources/log4j2-template.properties b/log4j2/src/test/resources/log4j2-template.properties
@@ -4,6 +4,7 @@ appender.qiniu.type = Log4j2QiniuAppender
 
 # change by yourself
 appender.qiniu.workflowName = logdemo1
+appender.qiniu.workflowDesc = log demo 1
 appender.qiniu.pipelineRepo = logpipe1
 appender.qiniu.logdbRepo = logdb1
 appender.qiniu.accessKey = ak

diff --git a/log4j2/src/test/resources/log4j2-template.xml b/log4j2/src/test/resources/log4j2-template.xml
@@ -5,6 +5,7 @@
                              pipelineHost="https://pipeline.qiniu.com"
                              logdbHost="https://logdb.qiniu.com"
                              workflowName="logdemo1"
+                             workflowDesc="log demo 1"
                              workflowRegion="nb"
                              pipelineRepo="logpipe1"
                              logdbRepo="logdb1"

diff --git a/logback/src/main/java/com/qiniu/appender/LogbackQiniuAppender.java b/logback/src/main/java/com/qiniu/appender/LogbackQiniuAppender.java
@@ -35,6 +35,7 @@ public class LogbackQiniuAppender extends AppenderBase<ILoggingEvent> implements
     private String pipelineHost;
     private String logdbHost;
     private String workflowName;
+    private String workflowDesc;
     private String workflowRegion;
     private String pipelineRepo;
     private String logdbRepo;
@@ -83,6 +84,14 @@ public void setWorkflowName(String workflowName) {
         this.workflowName = workflowName;
     }
 
+    public String getWorkflowDesc() {
+        return workflowDesc;
+    }
+
+    public void setWorkflowDesc(String workflowDesc) {
+        this.workflowDesc = workflowDesc;
+    }
+
     public String getWorkflowRegion() {
         return workflowRegion;
     }
@@ -318,7 +327,7 @@ public void start() {
         //try to create appender workflow
         try {
             QiniuAppenderClient.createAppenderWorkflow(pushPandoraClient, pipelineHost, logdbHost, workflowName,
-                    workflowRegion, pipelineRepo, logdbRepo, logdbRetention);
+                    workflowDesc, workflowRegion, pipelineRepo, logdbRepo, logdbRetention);
         } catch (Exception e) {
             e.printStackTrace();
             //@TODO better handle?

diff --git a/logback/src/main/java/com/qiniu/appender/QiniuAppenderClient.java b/logback/src/main/java/com/qiniu/appender/QiniuAppenderClient.java
@@ -19,15 +19,18 @@ public class QiniuAppenderClient implements ValueType, Analyzer, ExportWhence, W
      * Create appender workflow
      *
      * @param client         pandora client
+     * @param pipelineHost   pandora pipeline host
+     * @param logdbHost      pandora logdb host
      * @param workflowName   pandora workflow name
+     * @param workflowDesc   workflow description
      * @param workflowRegion pandora workflow region
      * @param pipelineRepo   pandora pipeline repo name
      * @param logdbRepo      pandora logdb repo name
      * @param logdbRetention pandora logdb retention days
      */
     public static void createAppenderWorkflow(PandoraClient client, String pipelineHost, String logdbHost,
-                                              String workflowName, String workflowRegion, String pipelineRepo,
-                                              String logdbRepo, String logdbRetention)
+                                              String workflowName, String workflowDesc, String workflowRegion,
+                                              String pipelineRepo, String logdbRepo, String logdbRetention)
             throws Exception {
         PipelineClient pipelineClient = null;
         if (pipelineHost != null && !pipelineHost.isEmpty()) {
@@ -47,6 +50,7 @@ public static void createAppenderWorkflow(PandoraClient client, String pipelineH
         if (!pipelineClient.workflowExists(workflowName)) {
             CreateWorkflowInput createWorkflowInput = new CreateWorkflowInput();
             createWorkflowInput.workflowName = workflowName;
+            createWorkflowInput.comment = workflowDesc;
             createWorkflowInput.region = workflowRegion;
             pipelineClient.createWorkflow(createWorkflowInput);
         }

diff --git a/logback/src/test/java/com/qiniu/tutorial/Slf4j.java b/logback/src/test/java/com/qiniu/tutorial/Slf4j.java
@@ -1,14 +1,5 @@
 package com.qiniu.tutorial;
 
-import ch.qos.logback.classic.LoggerContext;
-import com.qiniu.appender.LogbackQiniuAppender;
-import com.qiniu.pandora.common.PandoraClient;
-import com.qiniu.pandora.common.PandoraClientImpl;
-import com.qiniu.pandora.common.QiniuException;
-import com.qiniu.pandora.logdb.LogDBClient;
-import com.qiniu.pandora.pipeline.PipelineClient;
-import com.qiniu.pandora.util.Auth;
-import org.junit.Before;
 import org.junit.Test;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

diff --git a/logback/src/test/resources/logback-template.xml b/logback/src/test/resources/logback-template.xml
@@ -5,6 +5,7 @@
         <pipelineHost>https://pipeline.qiniuapi.com</pipelineHost>
         <logdbHost>https://logdb.qiniuapi.com</logdbHost>
         <workflowName>logdemo1</workflowName>
+        <workflowDesc>log demo 1</workflowDesc>
         <workflowRegion>nb</workflowRegion>
         <pipelineRepo>pipe1</pipelineRepo>
         <logdbRepo>logdb1</logdbRepo>