Browse files

Create a simply checklist of what is expected of clients

  • Loading branch information...
1 parent 48a32b6 commit 6883f0a95d15200af956033870fd8e4b95cfff09 @dcramer dcramer committed Oct 4, 2012
Showing with 16 additions and 0 deletions.
  1. +16 −0 docs/developer/client/index.rst
View
16 docs/developer/client/index.rst
@@ -6,6 +6,22 @@ logging parameters. Given these parameters, it then builds a JSON payload
which it will send to a Sentry server using some sort of authentication
method.
+The following items are expected of production-ready clients:
+
+* DSN configuration
+* Graceful failures (e.g. Sentry server unreachable)
+* Scrubbing w/ processors
+* Tag support
+
+Additionally, the following features are highly encouraged:
+
+* Automated error handling (e.g. default error handlers)
+* Logging integration (to whatever standard solution is available)
+* Non-blocking event submission
+
+Client Usage (End-user)
+-----------------------
+
Generally, a client consists of three steps to the end user, which should look
almost identical no matter the language:

0 comments on commit 6883f0a

Please sign in to comment.