# Workflow Log

## Workflow Log

### Description

![workflow log](/files/eUVCvXc5U9iImlb0ej6y)

Allows to log the activity of a workflow with a pipeline.

A workflow log streams logging information from a running workflow to a pipeline.

The only requirement for the receiving pipeline is that it starts with a [Workflow Logging](/data-shaper-1.21/knowing-the-data-shaper-designer/pipelines/transforms/workflow-logging.md) transform. Other than that, the logging pipeline is "just another pipeline". In this logging pipeline, you can process the logging information and e.g. write to a relational or NoSQL database, a Kafka topic etc

### Samples

The samples project comes with an example workflow log.

Check the metadata perspective for the workflow log `workflow-log-example`. This workflow log is configured to send logging information for the workflow `${PROJECT_HOME}/reflection/generate-fake-books.hwf` to the logging pipeline `${PROJECT_HOME}/reflection/workflow-log-example.hpl`.

<figure><img src="/files/4HrvXa32BRH89W6JZzyb" alt=""><figcaption></figcaption></figure>

### Related Plugins

* [Workflow Logging](/data-shaper-1.21/knowing-the-data-shaper-designer/pipelines/transforms/workflow-logging.md)

### Options

| Option                                 | Default                                   | Description                                                                                                                                                   |
| -------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name                                   | The name to be used for this workflow log |                                                                                                                                                               |
| Enabled?                               | true                                      |                                                                                                                                                               |
| Logging parent workflow only           | false                                     | If you enable this, only the parent workflow, executed by Hop Run, GUI, Server or API will be logged. When disabled, every workflow execution will be logged. |
| Pipeline executed to capture logging   |                                           | the pipeline to process the logging information for this workflow log                                                                                         |
| Execute at the start of the workflow?  | true                                      | Should this workflow log be executed at the start of a workflow run                                                                                           |
| Execute at the end of the workflow?    | false                                     | Should this workflow log be executed at the end of a workflow run                                                                                             |
| Execute periodically during execution? | true                                      | Should this workflow log be executed periodically during a workflow run                                                                                       |
| Interval in seconds                    | 30                                        | if executed periodically, indicates the interval at which the workflow log is executed                                                                        |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.primeur.com/data-shaper-1.21/knowing-the-data-shaper-designer/index-2/workflow-log.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
