Skip to content

Commit

Permalink
cleaned up formating on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kencochrane committed Feb 24, 2012
1 parent 745b30c commit eeaac0a
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.rst
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ Configuration
------------- -------------


Log4J configuration Log4J configuration
******************* ~~~~~~~~~~~~~~~~~~~
Check out src/test/java/resources/log4j_configuration.txt where you can see an example log4j config file. Check out src/test/java/resources/log4j_configuration.txt where you can see an example log4j config file.


You will need to add the SentryAppender and the sentry_dsn properties. You will need to add the SentryAppender and the sentry_dsn properties.


sentry_dsn sentry_dsn
~~~~~~~~~~ ^^^^^^^^^^
You will get this value from the "Projects / default / Manage / Member: <username>" page. It will be under "Client DSN". You will get this value from the "Projects / default / Manage / Member: <username>" page. It will be under "Client DSN".
Don't put quotes around it, because it will mess it up, just put it like you see it below. Don't put quotes around it, because it will mess it up, just put it like you see it below.


Expand All @@ -55,13 +55,13 @@ Log4j Config example::
log4j.appender.sentry.sentry_dsn=http://b4935bdd78624092ac2bc70fdcdb6f5a:7a37d9ad4765428180316bfec91a27ef@localhost:8000/1 log4j.appender.sentry.sentry_dsn=http://b4935bdd78624092ac2bc70fdcdb6f5a:7a37d9ad4765428180316bfec91a27ef@localhost:8000/1


Proxy Proxy
~~~~~ ^^^^^
If you need to use a proxy for HTTP transport, you can configure it as well:: If you need to use a proxy for HTTP transport, you can configure it as well::


log4j.appender.sentry.proxy=HTTP:proxyhost:proxyport log4j.appender.sentry.proxy=HTTP:proxyhost:proxyport


SENTRY_DSN Environment Variable SENTRY_DSN Environment Variable
******************************* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Raven-Java will first look to see if there is an environment variable called ``SENTRY_DSN`` set before it looks at the log4j config. If the environment variable is set, it will use that value instead of the one set in ``log4j.appender.sentry.sentry_dsn``. This is for a few reasons. Raven-Java will first look to see if there is an environment variable called ``SENTRY_DSN`` set before it looks at the log4j config. If the environment variable is set, it will use that value instead of the one set in ``log4j.appender.sentry.sentry_dsn``. This is for a few reasons.


1. Some hosting providers (Heroku, etc) have http://GetSentry.com plugins and they expose your Sentry settings via an environment variable. 1. Some hosting providers (Heroku, etc) have http://GetSentry.com plugins and they expose your Sentry settings via an environment variable.
Expand All @@ -70,7 +70,8 @@ Raven-Java will first look to see if there is an environment variable called ``S


Linux example:: Linux example::
# put this in your profile, or add it to a shell script that calls your java program. # put this in your profile, or add it to a shell script that calls your java program.
export SENTRY_DSN=http://b4935bdd78624092ac2bc70fdcdb6f5a:7a37d9ad4765428180316bfec91a27ef@localhost:8000/1
export SENTRY_DSN=http://b4935bdd78624092a:7a37d9ad47654281803f@localhost:8000/1


Usage Usage
----- -----
Expand Down

0 comments on commit eeaac0a

Please sign in to comment.