Dispatch Logging in Kibana

In Konvoy clusters, logs from Dispatch components and tasks can be found in Kibana.

Dispatch Component logs

The Dispatch CLI supports viewing the logs of the Pipelines Controller and Event Sink components.

To view the logs for pipelines-controller:

dispatch debug pipelines-controller

Log levels can be adjusted by setting them in Deployment object for controller. Controller output is structured by default and contains information about the pipeline launches.

To view the logs for event-sink (which is responsible for listening and processing Git repo events):

dispatch debug event-sink

In order to view the Dispatch component logs from Kibana UI, query syntax can be used. For example:

• To view event-sink pod logs:

{
  "query": {
    "match": {
      "kubernetes.labels.component": {
        "query": "event-sink",
        "type": "phrase"
      }
    }
  }
}

• To view the repository-controller pod logs:

{
  "query": {
    "match": {
      "kubernetes.labels.component": {
        "query": "repository-controller",
        "type": "phrase"
      }
    }
  }
}

Component logs can be filtered by the following labels:

Dispatch pipeline and task logs

Using the CLI to view the logs

In order to list pipeline runs:

dispatch ci list pipelineruns

The above command accepts an optional namespace flag to print pipelines from a specific namespace.

To list the tasks in a pipeline run (also prints the status of the task):

dispatch ci list tasks --pipelinerun <pipelineRunId>

Both the above commands accept --json flag for emitting JSON output for automation purposes

To view the logs of a task in a pipeline (or the pipeline logs if the pipeline is still active):

dispatch ci logs --pipelinerun <pipelineRunId> --task <taskName>

Using the Kibana dashboard to view the logs

You can also view the task logs for individual tasks and pipelines in Kibana. For example:

If you have CI configured for a repository called cicd-hello-world under the your-user GitHub account, and you create a PR from a branch called modify-readme, you can find the output generated by the build task using the following query:

{
  "query": {
    "bool": {
      "must": [
        {
          "match_all": {}
        },
        {
          "match_phrase": {
            "kubernetes.labels.build": {
              "query": "modify-readme"
            }
          }
        },
        {
          "match_phrase": {
            "kubernetes.labels.tekton_dev/task": {
              "query": "build"
            }
          }
        },
        {
          "match_phrase": {
            "kubernetes.labels.owner": {
              "query": "your-user"
            }
          }
        },
        {
          "match_phrase": {
            "kubernetes.labels.repository": {
              "query": "cicd-hello-world"
            }
          }
        }
      ]
    }
  }
}

Task logs are annotated with the following labels, which can all be queried in Kibana: