{"id":21163486,"url":"https://github.com/punktde/sentry-flow","last_synced_at":"2025-07-09T15:35:10.803Z","repository":{"id":28433483,"uuid":"117534805","full_name":"punktDe/sentry-flow","owner":"punktDe","description":"Sentry client package for the Flow framework","archived":false,"fork":false,"pushed_at":"2024-06-05T10:17:09.000Z","size":52,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-10-12T05:13:29.740Z","etag":null,"topics":["flowframework","sentry"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/punktDe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-15T11:04:47.000Z","updated_at":"2024-06-05T10:16:35.000Z","dependencies_parsed_at":"2024-06-04T17:11:12.048Z","dependency_job_id":null,"html_url":"https://github.com/punktDe/sentry-flow","commit_stats":{"total_commits":48,"total_committers":8,"mean_commits":6.0,"dds":"0.35416666666666663","last_synced_commit":"8f089a3ed605372fe6c417bedbb49a85a3f58e57"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/punktDe%2Fsentry-flow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/punktDe%2Fsentry-flow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/punktDe%2Fsentry-flow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/punktDe%2Fsentry-flow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/punktDe","download_url":"https://codeload.github.com/punktDe/sentry-flow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225567589,"owners_count":17489529,"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":["flowframework","sentry"],"created_at":"2024-11-20T13:47:50.717Z","updated_at":"2024-11-20T13:47:51.284Z","avatar_url":"https://github.com/punktDe.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [PunktDe.Sentry.Flow](https://github.com/punktDe/sentry-flow)\n\n[![Latest Stable Version](https://poser.pugx.org/punktDe/sentry-flow/v/stable)](https://packagist.org/packages/punktDe/sentry-flow) [![Total Downloads](https://poser.pugx.org/punktDe/sentry-flow/downloads)](https://packagist.org/packages/punktDe/sentry-flow) [![License](https://poser.pugx.org/punktDe/sentry-flow/license)](https://packagist.org/packages/punktDe/sentry-flow)\n\nThis is a Sentry client package for the Flow framework.\n\nHave a look at https://sentry.io for more information about Sentry.\n\n## Installation\n\n```\n$ composer require punktde/sentry-flow\n```\n\n### Compatibilty matrix\n\n| Flow Sentry Client | Flow             | Sentry SDK | Sentry Server |\n|--------------------|------------------|------------|---------------|\n| ^1.0               | ^4.0             | ^1.0       | *             |\n| ^2.0               | ^5.0             | ^1.0       | *             |\n| ^3.0               | ^5.0, ^6.0       | ^2.0       | *             |\n| ^4.0               | ^5.0 - ^8.0      | ^3.0       | \u003e= v20.6.0    |\n| ^5.0               | ^5.0 - ^9.0      | ^4.0       | \u003e= v20.6.0    |\n\n## Configuration\n\nAdd the following to your `Settings.yaml` and replace the `dsn` setting with your project DSN (API Keys in your Sentry project):\n\n```yaml\nPunktDe:\n  Sentry:\n    Flow:\n      dsn: 'https://public_key@your-sentry-server.com/project-id'\n```\n\nYou can also set the Sentry Environment to filter your exceptions by e.g. dev-/staging-/live-system.\nSet the env variable `SENTRY_ENVIRONMENT` or add your value to your `Settings.yaml`:\n\n```yaml\nPunktDe:\n  Sentry:\n    Flow:\n      environment: 'live'\n```\n\nFurthermore you can set the Sentry Release version to help to identifiy with which release an error occurred the first time.\nBy default, a file which is starting with the name `RELEASE_` is searched and the values after `RELEASE_` is used for Sentry.\nAlternatively you can override the filebased release number and set an environment variable `SENTRY_RELEASE` or add your value to your `Settings.yaml`:\n\n```yaml\nPunktDe:\n  Sentry:\n    Flow:\n      release: '5.0.3'\n```\nIf you need to use a custom transport e.g. to write the sentry reports to a file, you must implement the `Sentry\\TransportInterface`:\n\n```php\n\u003c?php\ndeclare(strict_types=1);\n\nnamespace Vendor\\Package\\Sentry\\Transport;\n\nuse Sentry\\Event;\nuse Sentry\\Exception\\JsonException;\nuse Sentry\\Transport\\TransportInterface;\nuse Sentry\\Util\\JSON;\n\nclass FileWriterTransport implements TransportInterface\n{\n    /**\n     * @param Event $event\n     *\n     * @return string|null Returns the ID of the event or `null` if it failed to be sent\n     *\n     * @throws JsonException\n     */\n    public function send(Event $event): ?string\n    {\n        if (file_put_contents('My\\Path\\And\\FileName', JSON::encode($event)) !== false) {\n            return $event-\u003egetId();\n        }\n        return null;\n    }\n}\n```\n\nThen you configure the class to be used:\n\n```yaml\nPunktDe:\n  Sentry:\n    Flow:\n      transportClass: '\\Vendor\\Package\\Sentry\\Transport\\FileWriterTransport'\n```\n\n## Usage\n\nSentry will log all exceptions that have the rendering option `logException` enabled. This can be enabled or disabled\nby status code or exception class according to the Flow configuration.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpunktde%2Fsentry-flow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpunktde%2Fsentry-flow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpunktde%2Fsentry-flow/lists"}