{"id":13813856,"url":"https://github.com/periskop-dev/periskop","last_synced_at":"2025-12-15T22:00:03.423Z","repository":{"id":39458137,"uuid":"198398912","full_name":"periskop-dev/periskop","owner":"periskop-dev","description":"Exception Monitoring Service","archived":false,"fork":false,"pushed_at":"2023-03-15T05:21:01.000Z","size":3234,"stargazers_count":185,"open_issues_count":18,"forks_count":15,"subscribers_count":62,"default_branch":"master","last_synced_at":"2024-11-19T08:47:21.278Z","etag":null,"topics":["error-monitoring","error-reporting","errors","exceptions","monitoring"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/periskop-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS"}},"created_at":"2019-07-23T09:34:02.000Z","updated_at":"2024-10-13T18:49:24.000Z","dependencies_parsed_at":"2024-01-15T13:33:32.342Z","dependency_job_id":null,"html_url":"https://github.com/periskop-dev/periskop","commit_stats":null,"previous_names":["soundcloud/periskop"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/periskop-dev%2Fperiskop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/periskop-dev%2Fperiskop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/periskop-dev%2Fperiskop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/periskop-dev%2Fperiskop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/periskop-dev","download_url":"https://codeload.github.com/periskop-dev/periskop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254256214,"owners_count":22040254,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["error-monitoring","error-reporting","errors","exceptions","monitoring"],"created_at":"2024-08-04T04:01:33.090Z","updated_at":"2025-12-15T21:59:58.400Z","avatar_url":"https://github.com/periskop-dev.png","language":"Go","readme":"# \u003cimg src=\"https://i.imgur.com/z8BLePO.png\" width=\"65%\"\u003e\n\n[![Build Status](https://api.cirrus-ci.com/github/periskop-dev/periskop.svg)](https://cirrus-ci.com/github/periskop-dev/periskop)\n[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/soundcloud/periskop)\n\nPull based, language agnostic exception aggregator for microservice environments.\n\nPeriskop scales well with the number of exceptions and application instances:\n\n  - Exceptions are pre-aggregated in client libraries and stored efficiently in memory, while keeping a sample of concrete occurrences for inspection.\n  - Exceptions are scraped and aggregated across instances by the server component.\n  - More application instances result in longer refresh cycles but the memory usage remains constant.\n\nA UI component is provided for convenience.\n\n## Scraping\n\nErrors are scraped and aggregated using a configured endpoint from each of the instances discovered via service discovery.\n\nPeriskop supports all service discovery mechanisms supported by Prometheus. The configuration format for service discovery\nmirrors the one from Prometheus. See [Prometheus's official documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/)\nfor reference.\n\nA full example of service configuration for Periskop can be found in the [sample configuration](config.dev.yaml).\n\n## Format\n\nThe format for scraped errors is defined in [a proto3 IDL](representation/errors.proto). Currently the only supported protocol is snake_cased JSON over HTTP ([example](scraper/sample-response1.json)).\n\n## UI\n\nThe UI allows navigating and inspecting exceptions as they occur.\n\n![ui](https://i.imgur.com/Tljxd80.png)\n\n## Run project locally\n\nPlease see [CONTRIBUTING.md](CONTRIBUTING.md)\n\n## Building \u0026 Running\n\nWe are looking into distributing Periskop via Docker Hub.\nIn the meantime, you can build and run Periskop from source:\n\n```\ndocker build --tag periskop .\ndocker run -v path/to/config.yaml:/etc/periskop/periskop.yaml -p 8080:8080 periskop\n```\n\n## Enable persistance storage\n\nBy default Periskop stores all the scrapped errors in memory [repository](repository/memory.go). You can configure your Periskop deployment to use persistent storage.\nCurrently the supported persistance storages are SQLite, MySQL and PostgreSQL. \n\nFor SQLite, add these lines to your `config.yaml` file:\n```yaml\nrepository:\n  type: sqlite\n  path: periskop.db\n```\n\nFor MySQL:\n```yaml\nrepository:\n  type: mysql\n  dsn: user:pass@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4\u0026parseTime=True\u0026loc=Local\n```\n  \nFor PostgreSQL:\n```yaml\nrepository:\n  type: postgres\n  dsn: host=localhost user=gorm password=gorm dbname=gorm port=9920 sslmode=disable\n```\n\n## Alert reported exceptions\n\nAll reported errors are instrumented with [Prometheus](https://prometheus.io) which provides alerting capabilities using [Alertmanager](https://prometheus.io/docs/alerting/alertmanager/). You can configure an alert when you reach some threshold of errors. Here's an example:\n\n```yaml\ngroups:\n- name: periskop\n  rules:\n  - alert: TooManyErrors\n    expr: periskop_error_occurrences{severity=\"error\"} \u003e 1000\n    for: 5m\n    labels:\n      severity: critical    \n    annotations:\n      summary: \"Too many errors on {{ $labels.service_name }}\"\n      description: \"Errors for {{ $labels.service_name }}({{ $labels.aggregation_key }}) is {{ $value }}\"\n      dashboard: \"https://periskop.example.com/#/{{ $labels.service_name }}/errors/{{ $labels.aggregation_key }}\"\n```\n\n## Pushgateway\n\nSee [periskop-pushgateway](https://github.com/periskop-dev/periskop-pushgateway) if you want to use Periskop as push based metric system.\n\n## Client Libraries\n\n  - [periskop-scala](https://github.com/periskop-dev/periskop-scala)\n  - [periskop-go](https://github.com/periskop-dev/periskop-go)\n  - [periskop-python](https://github.com/periskop-dev/periskop-python)\n  - [periskop-ruby](https://github.com/periskop-dev/periskop-ruby)\n\n## Integrations\n\n  - [Backstage plugin](https://github.com/backstage/backstage/blob/master/plugins/periskop)\n\n![backstage-plugin](https://github.com/backstage/backstage/blob/3131784fb71ac35ec24cea433a37bc5cab0595f9/plugins/periskop/docs/periskop-plugin-screenshot.png?raw=true)\n","funding_links":[],"categories":["Go"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperiskop-dev%2Fperiskop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fperiskop-dev%2Fperiskop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperiskop-dev%2Fperiskop/lists"}