Improve documentation about config

[VincentLanglet]

I've made a huge update with sentry, updating from 0.8.* to 3.0.*.
Now I received error message for every Symfony\Component\Security\Core\Exception\AccessDeniedException.

I'd like to ignore this options. I found some post talking about an excluded_exceptions but I found no documentation about it...

The https://github.com/getsentry/sentry-symfony#step-3-configure-the-sdk section should be updated with all the available option and how to use them.

[Jean85]

We already addressed this in #207 and fixed it with #208. We have a dedicated upgrade document, and all the additional options come from the base SDK, that has its own documentation: https://docs.sentry.io/error-reporting/configuration/?platform=php

[VincentLanglet]

A new user won't look at the upgrade document to know the config option. You should not consider this as a documentation.

I think it will still be a good improvement to give a full example of config in the README, like this

sentry:
    dsn: ...
    options:
        ...
        excluded_exception:
            - Symfony\Component\Security\Core\Exception\AccessDeniedException

The sentry documentation https://docs.sentry.io/error-reporting/configuration/?platform=php doesn't even talk about the excluded_exception option.

[Jean85]

My mistake, that page is about the options available across all SDK in all languages, due to the Unified API approach.

There are a few PHP specific ones, documented in the PHP docs: https://docs.sentry.io/platforms/php/#php-specific-options

[B-Galati]

I just had the same issue when was setting up the bundle.

[B-Galati]

I used the command bin/console config:dump-reference sentry to know more about available options but that is far from ideal from my POV.

[Jean85]

What would you suggest as a fix for this issue? Would adding these two links to the readme be enough? PRs are welcome.

[VincentLanglet]

@Jean85 In the step https://github.com/getsentry/sentry-symfony#step-3-configure-the-sdk

Adding something like

Every options from the sentry documentation can be used:
- https://docs.sentry.io/error-reporting/configuration/?platform=php
- https://docs.sentry.io/platforms/php/#php-specific-options

Would be great indeed

But it's always better with an example:

sentry:
    dsn: "https://public:secret@sentry.example.com/1"
    environment: %kernel.environment%
    project_root: %kernel.project_dir%
    excluded_exceptions:
        - PersonalIgnoredException

[B-Galati]

What would you suggest as a fix for this issue? Would adding these two links to the readme be enough? PRs are welcome.

Agree with @VincentLanglet and it is good to give concrete use case, full config example, document every single option the bundle gives. All of these is not trivial when you want to get started as quickly as possible.

[Jean85]

I would prefer not to document all of them there since it's too easy to go out of sync with the base SDK. But a smallish concrete example and the two links are IMHO really good.

[VincentLanglet]

I would prefer not to document all of them there since it's too easy to go out of sync with the base SDK. But a smallish concrete example and the two links are IMHO really good.

I think a smallish concrete example is enough.

[B-Galati]

I would prefer not to document all of them there since it's too easy to go out of sync with the base SDK. But a smallish concrete example and the two links are IMHO really good.

I am not saying it's good to document them in detail. I am saying it should be indicated that they exist and what type of data is expected and then reference to the SDK documentation.

[B-Galati]

I just so the new doc at https://docs.sentry.io/platforms/php/symfony/ -> looks great.

It is confusing to find information about the bundle in both README.md and https://docs.sentry.io/platforms/php/symfony/.

Perhaps the README.md should link to https://docs.sentry.io/platforms/php/symfony/? Or the other way?

[Jean85]

It's probably best to link to the docs, since a link to the base SDK options would be good too.