Skip to content

Commit

Permalink
Merge pull request #1 from hookdeck/feat/event-data
Browse files Browse the repository at this point in the history
Extract event data from Requests and Events and improve logging
  • Loading branch information
leggetter authored Sep 30, 2024
2 parents 8306cba + d113a0d commit 0755008
Show file tree
Hide file tree
Showing 6 changed files with 797 additions and 164 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ generators: [
[
"@hookdeck/eventcatalog-generator",
{
debug: true,
logLevel: "fatal" | "error" | "warn" | "info" | "debug" | "trace",
connectionSourcedMatch: "regular expression string to match source names",
hookdeckApiKey: "Hookdeck Project API Key. Hookdeck -> Project -> Settings -> Secrets"
}
Expand Down Expand Up @@ -55,10 +55,17 @@ npm run generate -- {flags}

Supported flags are:

- `debug`: Output debug information to the console
- `log-level`: The level to log at - "fatal" | "error" | "warn" | "info" | "debug" | "trace"
- `match`: Regular expression match for Source names on Connections
- `dir`: Path the the Event Catalog install directory
- `api-key`: Hookdeck Project API Key
- `max-events`: The maximum number of Requests/Events to process per Source/Destination

Example:

```sh
npm run generate -- --log-level debug --match "stripe-production" --domain Payments
```

The `generate` script will also use the following environment variables:

Expand Down
Loading

0 comments on commit 0755008

Please sign in to comment.