Hawk

https://docs.hawk.so/
Admin
Hawk is a clever, user-friendly, and open-source error tracker that collects code exceptions and...
Tokens:5,887
Snippets:95
Trust Score:7.3
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Send commits in GitHub Actions workflow

Source: https://docs.hawk.so/releases

GitHub Actions job that gets the package name and version, then downloads and runs the commits.sh script to send commits to Hawk. Uses the HAWK_TOKEN environment variable.

```yaml
jobs:
  build:
    runs-on: ubuntu-20.04
    steps:
      # Get package new version name
      - name: Get package info
        id: packageInfo
        uses: codex-team/action-nodejs-package-info@v1
      - name: Send commits to Hawk
        run: |
          curl https://raw.githubusercontent.com/codex-team/hawk.releases/main/scripts/commits.sh -O
          chmod +x ./commits.sh
          ./commits.sh -r=${{ steps.package.outputs.name }}-${{ steps.package.outputs.version }} -t=${{ env.HAWK_TOKEN }}
          rm ./commits.sh
```

--------------------------------

### Send commits manually with shell script

Source: https://docs.hawk.so/releases

Run the commits.sh script from the hawk.releases repository to send commits for a release. Use the --release flag for the release name and --token for the integration token.

```bash
$ ./commits.sh --release="Version 2.0.1" --token=eyJ...integrationToken...
```

--------------------------------

### Configure Hawk Webpack Plugin for source maps

Source: https://docs.hawk.so/releases

Use the @hawk.so/webpack-plugin to automatically send JavaScript source maps and a few last commits to Hawk. Requires your project's Integration Token. Set devtool to 'hidden-source-map'.

```javascript
const HawkWebpackPlugin = require('@hawk.so/webpack-plugin');
module.exports = {
  // ... other webpack options
  plugins: [
    new HawkWebpackPlugin({
      integrationToken: '' // Your project's Integration Token
    })
  ],
  devtool: 'hidden-source-map',
}
```

--------------------------------

### Collector Endpoint

Source: https://docs.hawk.so/endpoint-and-credentials

Documentation for the collector endpoint, including the POST request and WebSocket connection details.

```APIDOC
## POST https://0446eed7-bf24-4ba7-9fd9-b2212d3cfc89.k1.hawk.so:433

### Description
Send a POST request to the collector endpoint to submit data. The endpoint URL includes the integration ID and the collector URL, allowing for load balancing across projects.

### Method
POST

### Endpoint
https://0446eed7-bf24-4ba7-9fd9-b2212d3cfc89.k1.hawk.so:433

### Authentication
Integration token is encoded in base64. A decoded token is a JSON object containing the integration ID and secret.

### Request Example
{
  "integrationId": "0446eed7-bf24-4ba7-9fd9-b2212d3cfc89",
  "secret": "b0109db9-8836-4d33-bc69-cbfc651c3ec3"
}
```

```APIDOC
## WebSocket wss://0446eed7-bf24-4ba7-9fd9-b2212d3cfc89.k1.hawk.so:433/ws

### Description
Connect to the collector endpoint using WebSockets to send data. The WebSocket URL includes the integration ID and the collector URL.

### Method
WebSocket

### Endpoint
wss://0446eed7-bf24-4ba7-9fd9-b2212d3cfc89.k1.hawk.so:433/ws

### Authentication
Integration token is encoded in base64. A decoded token is a JSON object containing the integration ID and secret.
```

--------------------------------

### Filter sensitive data with beforeSend hook

Source: https://docs.hawk.so/sensitive-data-filtering

Use this hook in the HawkCatcher configuration to remove sensitive fields, such as a user's email, from events before they are sent to Hawk. The hook receives the event object and must return the modified event.

```javascript
const hawk = new HawkCatcher({ token: 'INTEGRATION_TOKEN', beforeSend(event) { // Modify the event here if (event.user) { // Don't send user's email address delete event.user.email; } return event; }, });
```
Tokens:
Raw