> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# circleci/sumologic

Report CircleCI job analytics to your SumoLogic dashboard.


## Commands

### submit

"Collect data from this job and report to SumoLogic. Note: MUST BE LAST COMMAND IN JOB."


| Parameter | Type | Default | Description |
|---|---|---|---|
| `http-source` | env_var_name | HTTP_SOURCE | Enter the HTTP Source endpoint generated by the Sumologic setup wizard. |
| `path` | string |  | absolute or relative path to the logfile you wish to upload. |

## Jobs

### workflow-collector

"Add this job to your workflow with no require statements. This job will run in parallel with the rest of your workflow for monitoring and will exit when all other jobs have completed."


| Parameter | Type | Default | Description |
|---|---|---|---|
| `circle-token` | env_var_name | CIRCLE_TOKEN | Enter your CircleCI Personal Access Token for interacting with the API. You may generate one here: https://circleci.com/account/api |
| `custom-data` | string |  | A valid JSON object to append to the workflow data. |
| `job-collector` | env_var_name | JOB_HTTP_SOURCE | Enter the HTTP Source endpoint generated by the Sumologic setup wizard for Workflows. |
| `workflow-collector` | env_var_name | WORKFLOW_HTTP_SOURCE | Enter the HTTP Source endpoint generated by the Sumologic setup wizard for Workflows. |

## Executors

### default

Default reporting environment for Sumologic. This is a small Ubuntu based Docker image with a low resource class. Designed to load fast and use few credits.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `image` | string | cimg/base | Docker image name |
| `tag` | string | stable | Docker image tag |

## Examples

### workflow_collector

This example workflow shows a typical build, test, and deploy job in a single workflow. By adding the Sumo Logic Orb to the top of our config and including the provided "workflow-collector" job, analytics may be automatically reported to the CircleCI App for Sumo Logic. You must also setup the CircleCI App on Sumo Logic


```yaml
version: '2.1'
orbs:
  sumologic: circleci/sumologic@x.y.z
jobs:
  build:
    docker:
      - image: cimg/node
    steps:
      - run: echo "This job represents a typical build job"
  deploy:
    docker:
      - image: cimg/node
    steps:
      - run: echo "This job represents a typical deploy job"
  test:
    docker:
      - image: cimg/node
    steps:
      - run: echo "This job represents a typical test job"
workflows:
  build-test-and-deploy:
    jobs:
      - sumologic/workflow-collector:
          custom-data: |
            {"foo": "bar", "$SOME_KEY_VAR": "$SOME_VALUE_VAR"}
      - build
      - test:
          requires:
            - build
      - deploy:
          requires:
            - test
```