Buggregator docs

Appearance

Configuration — Projects ​

Buggregator lets you use "projects" to help organize your data. Projects are useful for keeping events from different teams, applications, or environments separate.

image

Here's why you might want to use projects:

  1. Projects help you keep data from different teams or parts of your app separate. This means it's easier to find what you're looking for and keep track of changes.
  2. Teams won't get mixed up with data that isn't relevant to them, which makes their work faster and less confusing.
  3. The sidebar displays a project selector dropdown, allowing you to quickly switch between projects and view only the events relevant to the selected project.

Default Project ​

When you start the server, Buggregator automatically sets up a default project with key default. All your data goes into this default project if a project key is not specified in the request.

Configuration ​

Projects are configured in buggregator.yaml:

yaml
projects:
  - key: my-app
    name: My Application
  - key: staging
    name: Staging Environment
  - key: mobile
    name: Mobile App

Docker Compose Example ​

yaml
services:
  buggregator:
    image: ghcr.io/buggregator/server:latest
    ports:
      - 127.0.0.1:8000:8000
    volumes:
      - ./buggregator.yaml:/buggregator.yaml

With buggregator.yaml:

yaml
projects:
  - key: backend
    name: Backend API
  - key: frontend
    name: Frontend App

Sentry Configuration ​

To use Sentry with your project, format your DSN like this:

dotenv
SENTRY_DSN=http://<secret_key>@127.0.0.1:8000/<project_key>

Note: Read more about Sentry configuration here.

Inspector Configuration ​

To use Inspector with your project, format your DSN like this:

dotenv
INSPECTOR_URL=http://inspector:<project_key>@127.0.0.1:8000
INSPECTOR_API_KEY=<secret_key>

Note: Read more about Inspector configuration here.

Xhprof Profiler Configuration ​

To set up the Profiler, use this:

dotenv
PROFILER_ENDPOINT=http://profiler:<project_key>@127.0.0.1:8000

Note: Read more about Xhprof Profiler configuration here.

Ray Configuration ​

For Ray, use these settings:

dotenv
RAY_HOST=ray:<project_key>@127.0.0.1
RAY_PORT=8000

VarDumper Configuration ​

At this moment, VarDumper does not support projects.

Monolog Configuration ​

At this moment, Monolog does not support projects.