Skip to content

Commit

Permalink
docs(integrations): update integrations docs (#3252)
Browse files Browse the repository at this point in the history
  • Loading branch information
rogeriopeixotocx authored May 12, 2021
1 parent 7b01a81 commit aeda580
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
8 changes: 8 additions & 0 deletions docs/usage/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,14 @@ The other commands have no further options.

---

## Profiling

With the `--profiling` flag KICS will print resource consumption information in the logs.

You can only enable one profiler at a time, CPU or MEM.

📝 Please note that execution time may be impacted by enabling performance profiler due to sampling

## Disable Telemetry

You can disable KICS telemetry with `KICS_COLLECT_TELEMETRY` environment variable set to `0` or `false` e.g:
Expand Down
7 changes: 5 additions & 2 deletions examples/github/kics-docker-runner-sarif.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,19 @@ jobs:
# make sure results dir is created
run: mkdir -p results-dir
- name: Run KICS Scan with SARIF result
uses: checkmarx/kics-action@docker-runner
uses: checkmarx/kics-action@latest
with:
path: 'terraform'
# comma separated list of paths
path: 'terraform,my-subdir,my-other-subdir/my-file.tf'
# when provided with a directory on output_path
# it will generate the specified reports file named 'results.{extension}'
# in this example it will generate:
# - results-dir/results.json
# - results-dir/results.sarif
output_path: results-dir
platform_type: terraform
# Will exit with status code 0 even if results are found
ignore_on_exit: results
output_formats: 'json,sarif'
exclude_paths: "terraform/gcp/big_data.tf,terraform/azure"
# look for the queries' ID in its metadata.json
Expand Down

0 comments on commit aeda580

Please sign in to comment.