File tree Expand file tree Collapse file tree 2 files changed +38
-1
lines changed
Expand file tree Collapse file tree 2 files changed +38
-1
lines changed Original file line number Diff line number Diff line change @@ -108,3 +108,8 @@ Renku Command Line
108108------------------
109109
110110.. automodule :: renku.cli.githooks
111+
112+ Error Tracking
113+ --------------
114+
115+ .. automodule :: renku.cli._exc
Original file line number Diff line number Diff line change 1515# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1616# See the License for the specific language governing permissions and
1717# limitations under the License.
18- """The exception handlers."""
18+ """Renku is not bug-free and you can help us to find them.
19+
20+ GitHub
21+ ~~~~~~
22+
23+ You can quickly open an issue on GitHub with a traceback and minimal system
24+ information when you hit an unhandled exception in the CLI.
25+
26+ .. code-block:: text
27+
28+ Ahhhhhhhh! You have found a bug. 🐞
29+
30+ 1. Open an issue by typing "open";
31+ 2. Print human-readable information by typing "print";
32+ 3. See the full traceback without submitting details (default: "ignore").
33+
34+ Please select an action by typing its name (open, print, ignore) [ignore]:
35+
36+ Sentry
37+ ~~~~~~
38+
39+ When using ``renku`` as a hosted service the Sentry integration can be enabled
40+ to help developers iterate faster by showing them where bugs happen, how often,
41+ and who's affected.
42+
43+ 1. Install Sentry-SDK by ``python -m pip install sentry-sdk``;
44+ 2. Set environment variable
45+ ``SENTRY_DSN=https://<key>@sentry.<domain>/<project>``.
46+
47+ .. warning:: User information might be sent to help resolving the problem.
48+ If you are not using your own Sentry instance you should inform users
49+ that you are sending possibly sensitive information to a 3rd-party service.
50+ """
1951
2052import os
2153import platform
You can’t perform that action at this time.
0 commit comments