sentry-raven 2.7.4 → 3.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (212) hide show
  1. checksums.yaml +5 -5
  2. data/.craft.yml +15 -0
  3. data/.github/ISSUE_TEMPLATE/bug_report.md +32 -0
  4. data/.github/pull_request_template.md +16 -0
  5. data/.github/workflows/test.yml +92 -0
  6. data/.github/workflows/zeus_upload.yml +32 -0
  7. data/.gitignore +3 -1
  8. data/.gitmodules +0 -3
  9. data/.rubocop.yml +50 -12
  10. data/.scripts/bump-version.sh +9 -0
  11. data/{changelog.md → CHANGELOG.md} +238 -1
  12. data/CONTRIBUTING.md +71 -0
  13. data/Gemfile +21 -26
  14. data/README.md +42 -22
  15. data/lib/raven/backtrace.rb +9 -5
  16. data/lib/raven/base.rb +8 -3
  17. data/lib/raven/breadcrumbs.rb +1 -1
  18. data/lib/raven/breadcrumbs/{activesupport.rb → active_support_logger.rb} +9 -3
  19. data/lib/raven/breadcrumbs/logger.rb +2 -92
  20. data/lib/raven/breadcrumbs/sentry_logger.rb +73 -0
  21. data/lib/raven/cli.rb +10 -21
  22. data/lib/raven/client.rb +37 -11
  23. data/lib/raven/configuration.rb +141 -20
  24. data/lib/raven/context.rb +13 -8
  25. data/lib/raven/core_ext/object/deep_dup.rb +57 -0
  26. data/lib/raven/core_ext/object/duplicable.rb +153 -0
  27. data/lib/raven/event.rb +29 -37
  28. data/lib/raven/helpers/deprecation_helper.rb +17 -0
  29. data/lib/raven/instance.rb +30 -8
  30. data/lib/raven/integrations/delayed_job.rb +16 -16
  31. data/lib/raven/integrations/rack-timeout.rb +7 -4
  32. data/lib/raven/integrations/rack.rb +19 -5
  33. data/lib/raven/integrations/rails.rb +13 -3
  34. data/lib/raven/integrations/rails/active_job.rb +11 -7
  35. data/lib/raven/integrations/rails/backtrace_cleaner.rb +29 -0
  36. data/lib/raven/integrations/rails/controller_transaction.rb +1 -1
  37. data/lib/raven/integrations/rails/overrides/debug_exceptions_catcher.rb +2 -2
  38. data/lib/raven/integrations/sidekiq.rb +4 -78
  39. data/lib/raven/integrations/sidekiq/cleanup_middleware.rb +13 -0
  40. data/lib/raven/integrations/sidekiq/error_handler.rb +38 -0
  41. data/lib/raven/interface.rb +2 -2
  42. data/lib/raven/interfaces/stack_trace.rb +1 -1
  43. data/lib/raven/linecache.rb +5 -2
  44. data/lib/raven/logger.rb +3 -2
  45. data/lib/raven/processor/cookies.rb +16 -6
  46. data/lib/raven/processor/post_data.rb +2 -0
  47. data/lib/raven/processor/removecircularreferences.rb +3 -1
  48. data/lib/raven/processor/sanitizedata.rb +65 -17
  49. data/lib/raven/processor/utf8conversion.rb +3 -1
  50. data/lib/raven/transports.rb +4 -0
  51. data/lib/raven/transports/http.rb +5 -7
  52. data/lib/raven/transports/stdout.rb +20 -0
  53. data/lib/raven/utils/context_filter.rb +42 -0
  54. data/lib/raven/utils/exception_cause_chain.rb +20 -0
  55. data/lib/raven/utils/real_ip.rb +1 -1
  56. data/lib/raven/version.rb +2 -2
  57. data/lib/sentry-raven-without-integrations.rb +6 -1
  58. data/lib/sentry_raven_without_integrations.rb +1 -0
  59. data/sentry-raven.gemspec +3 -4
  60. data/sentry-ruby/.gitignore +11 -0
  61. data/sentry-ruby/.rspec +3 -0
  62. data/sentry-ruby/.travis.yml +6 -0
  63. data/sentry-ruby/CODE_OF_CONDUCT.md +74 -0
  64. data/sentry-ruby/Gemfile +9 -0
  65. data/sentry-ruby/LICENSE.txt +21 -0
  66. data/sentry-ruby/README.md +44 -0
  67. data/sentry-ruby/Rakefile +6 -0
  68. data/sentry-ruby/bin/console +14 -0
  69. data/sentry-ruby/bin/setup +8 -0
  70. data/sentry-ruby/examples/rails-6.0/.browserslistrc +1 -0
  71. data/sentry-ruby/examples/rails-6.0/.gitignore +35 -0
  72. data/sentry-ruby/examples/rails-6.0/Gemfile +58 -0
  73. data/sentry-ruby/examples/rails-6.0/README.md +23 -0
  74. data/sentry-ruby/examples/rails-6.0/Rakefile +6 -0
  75. data/sentry-ruby/examples/rails-6.0/app/assets/config/manifest.js +2 -0
  76. data/sentry-ruby/examples/rails-6.0/app/assets/images/.keep +0 -0
  77. data/sentry-ruby/examples/rails-6.0/app/assets/stylesheets/application.css +15 -0
  78. data/sentry-ruby/examples/rails-6.0/app/channels/application_cable/channel.rb +4 -0
  79. data/sentry-ruby/examples/rails-6.0/app/channels/application_cable/connection.rb +4 -0
  80. data/sentry-ruby/examples/rails-6.0/app/controllers/application_controller.rb +2 -0
  81. data/sentry-ruby/examples/rails-6.0/app/controllers/concerns/.keep +0 -0
  82. data/sentry-ruby/examples/rails-6.0/app/controllers/welcome_controller.rb +23 -0
  83. data/sentry-ruby/examples/rails-6.0/app/helpers/application_helper.rb +2 -0
  84. data/sentry-ruby/examples/rails-6.0/app/javascript/channels/consumer.js +6 -0
  85. data/sentry-ruby/examples/rails-6.0/app/javascript/channels/index.js +5 -0
  86. data/sentry-ruby/examples/rails-6.0/app/javascript/packs/application.js +17 -0
  87. data/sentry-ruby/examples/rails-6.0/app/jobs/application_job.rb +7 -0
  88. data/sentry-ruby/examples/rails-6.0/app/mailers/application_mailer.rb +4 -0
  89. data/sentry-ruby/examples/rails-6.0/app/models/application_record.rb +3 -0
  90. data/sentry-ruby/examples/rails-6.0/app/models/concerns/.keep +0 -0
  91. data/sentry-ruby/examples/rails-6.0/app/views/layouts/application.html.erb +15 -0
  92. data/sentry-ruby/examples/rails-6.0/app/views/layouts/mailer.html.erb +13 -0
  93. data/sentry-ruby/examples/rails-6.0/app/views/layouts/mailer.text.erb +1 -0
  94. data/sentry-ruby/examples/rails-6.0/app/views/welcome/report_demo.html.erb +22 -0
  95. data/sentry-ruby/examples/rails-6.0/app/views/welcome/view_error.html.erb +1 -0
  96. data/sentry-ruby/examples/rails-6.0/app/workers/error_worker.rb +7 -0
  97. data/sentry-ruby/examples/rails-6.0/babel.config.js +72 -0
  98. data/sentry-ruby/examples/rails-6.0/bin/bundle +114 -0
  99. data/sentry-ruby/examples/rails-6.0/bin/rails +9 -0
  100. data/sentry-ruby/examples/rails-6.0/bin/rake +9 -0
  101. data/sentry-ruby/examples/rails-6.0/bin/setup +36 -0
  102. data/sentry-ruby/examples/rails-6.0/bin/spring +17 -0
  103. data/sentry-ruby/examples/rails-6.0/bin/webpack +18 -0
  104. data/sentry-ruby/examples/rails-6.0/bin/webpack-dev-server +18 -0
  105. data/sentry-ruby/examples/rails-6.0/bin/yarn +11 -0
  106. data/sentry-ruby/examples/rails-6.0/config.ru +5 -0
  107. data/sentry-ruby/examples/rails-6.0/config/application.rb +28 -0
  108. data/sentry-ruby/examples/rails-6.0/config/boot.rb +4 -0
  109. data/sentry-ruby/examples/rails-6.0/config/cable.yml +10 -0
  110. data/sentry-ruby/examples/rails-6.0/config/credentials.yml.enc +1 -0
  111. data/sentry-ruby/examples/rails-6.0/config/database.yml +25 -0
  112. data/sentry-ruby/examples/rails-6.0/config/environment.rb +5 -0
  113. data/sentry-ruby/examples/rails-6.0/config/environments/development.rb +62 -0
  114. data/sentry-ruby/examples/rails-6.0/config/environments/production.rb +112 -0
  115. data/sentry-ruby/examples/rails-6.0/config/environments/test.rb +48 -0
  116. data/sentry-ruby/examples/rails-6.0/config/initializers/application_controller_renderer.rb +8 -0
  117. data/sentry-ruby/examples/rails-6.0/config/initializers/assets.rb +14 -0
  118. data/sentry-ruby/examples/rails-6.0/config/initializers/backtrace_silencers.rb +7 -0
  119. data/sentry-ruby/examples/rails-6.0/config/initializers/content_security_policy.rb +30 -0
  120. data/sentry-ruby/examples/rails-6.0/config/initializers/cookies_serializer.rb +5 -0
  121. data/sentry-ruby/examples/rails-6.0/config/initializers/filter_parameter_logging.rb +4 -0
  122. data/sentry-ruby/examples/rails-6.0/config/initializers/inflections.rb +16 -0
  123. data/sentry-ruby/examples/rails-6.0/config/initializers/mime_types.rb +4 -0
  124. data/sentry-ruby/examples/rails-6.0/config/initializers/wrap_parameters.rb +14 -0
  125. data/sentry-ruby/examples/rails-6.0/config/locales/en.yml +33 -0
  126. data/sentry-ruby/examples/rails-6.0/config/puma.rb +38 -0
  127. data/sentry-ruby/examples/rails-6.0/config/routes.rb +10 -0
  128. data/sentry-ruby/examples/rails-6.0/config/spring.rb +6 -0
  129. data/sentry-ruby/examples/rails-6.0/config/storage.yml +34 -0
  130. data/sentry-ruby/examples/rails-6.0/config/webpack/development.js +5 -0
  131. data/sentry-ruby/examples/rails-6.0/config/webpack/environment.js +3 -0
  132. data/sentry-ruby/examples/rails-6.0/config/webpack/production.js +5 -0
  133. data/sentry-ruby/examples/rails-6.0/config/webpack/test.js +5 -0
  134. data/sentry-ruby/examples/rails-6.0/config/webpacker.yml +96 -0
  135. data/sentry-ruby/examples/rails-6.0/db/seeds.rb +7 -0
  136. data/sentry-ruby/examples/rails-6.0/lib/assets/.keep +0 -0
  137. data/sentry-ruby/examples/rails-6.0/lib/tasks/.keep +0 -0
  138. data/sentry-ruby/examples/rails-6.0/package.json +15 -0
  139. data/sentry-ruby/examples/rails-6.0/postcss.config.js +12 -0
  140. data/sentry-ruby/examples/rails-6.0/public/404.html +67 -0
  141. data/sentry-ruby/examples/rails-6.0/public/422.html +67 -0
  142. data/sentry-ruby/examples/rails-6.0/public/500.html +66 -0
  143. data/sentry-ruby/examples/rails-6.0/public/apple-touch-icon-precomposed.png +0 -0
  144. data/sentry-ruby/examples/rails-6.0/public/apple-touch-icon.png +0 -0
  145. data/sentry-ruby/examples/rails-6.0/public/favicon.ico +0 -0
  146. data/sentry-ruby/examples/rails-6.0/public/robots.txt +1 -0
  147. data/sentry-ruby/examples/rails-6.0/storage/.keep +0 -0
  148. data/sentry-ruby/examples/rails-6.0/test/application_system_test_case.rb +5 -0
  149. data/sentry-ruby/examples/rails-6.0/test/channels/application_cable/connection_test.rb +11 -0
  150. data/sentry-ruby/examples/rails-6.0/test/controllers/.keep +0 -0
  151. data/sentry-ruby/examples/rails-6.0/test/fixtures/.keep +0 -0
  152. data/sentry-ruby/examples/rails-6.0/test/fixtures/files/.keep +0 -0
  153. data/sentry-ruby/examples/rails-6.0/test/helpers/.keep +0 -0
  154. data/sentry-ruby/examples/rails-6.0/test/integration/.keep +0 -0
  155. data/sentry-ruby/examples/rails-6.0/test/mailers/.keep +0 -0
  156. data/sentry-ruby/examples/rails-6.0/test/models/.keep +0 -0
  157. data/sentry-ruby/examples/rails-6.0/test/system/.keep +0 -0
  158. data/sentry-ruby/examples/rails-6.0/test/test_helper.rb +13 -0
  159. data/sentry-ruby/examples/rails-6.0/vendor/.keep +0 -0
  160. data/sentry-ruby/examples/rails-6.0/yarn.lock +7508 -0
  161. data/sentry-ruby/lib/sentry.rb +16 -0
  162. data/sentry-ruby/lib/sentry/backtrace.rb +128 -0
  163. data/sentry-ruby/lib/sentry/client.rb +162 -0
  164. data/sentry-ruby/lib/sentry/client/state.rb +40 -0
  165. data/sentry-ruby/lib/sentry/configuration.rb +533 -0
  166. data/sentry-ruby/lib/sentry/event.rb +209 -0
  167. data/sentry-ruby/lib/sentry/interface.rb +31 -0
  168. data/sentry-ruby/lib/sentry/interfaces/exception.rb +15 -0
  169. data/sentry-ruby/lib/sentry/interfaces/http.rb +16 -0
  170. data/sentry-ruby/lib/sentry/interfaces/message.rb +18 -0
  171. data/sentry-ruby/lib/sentry/interfaces/single_exception.rb +14 -0
  172. data/sentry-ruby/lib/sentry/interfaces/stack_trace.rb +69 -0
  173. data/sentry-ruby/lib/sentry/linecache.rb +44 -0
  174. data/sentry-ruby/lib/sentry/logger.rb +20 -0
  175. data/sentry-ruby/lib/sentry/transports.rb +19 -0
  176. data/sentry-ruby/lib/sentry/transports/dummy.rb +16 -0
  177. data/sentry-ruby/lib/sentry/transports/http.rb +66 -0
  178. data/sentry-ruby/lib/sentry/transports/stdout.rb +20 -0
  179. data/sentry-ruby/lib/sentry/utils/deep_merge.rb +22 -0
  180. data/sentry-ruby/lib/sentry/utils/exception_cause_chain.rb +20 -0
  181. data/sentry-ruby/lib/sentry/version.rb +3 -0
  182. data/sentry-ruby/sentry-ruby.gemspec +26 -0
  183. data/sentry-ruby/spec/sentry/backtrace_spec.rb +38 -0
  184. data/sentry-ruby/spec/sentry/client_spec.rb +443 -0
  185. data/sentry-ruby/spec/sentry/configuration_spec.rb +400 -0
  186. data/sentry-ruby/spec/sentry/event_spec.rb +238 -0
  187. data/sentry-ruby/spec/sentry/interface_spec.rb +38 -0
  188. data/sentry-ruby/spec/sentry/interfaces/stack_trace_spec.rb +11 -0
  189. data/sentry-ruby/spec/sentry/linecache_spec.rb +40 -0
  190. data/sentry-ruby/spec/sentry/transports/http_spec.rb +57 -0
  191. data/sentry-ruby/spec/sentry/transports/stdout_spec.rb +11 -0
  192. data/sentry-ruby/spec/sentry_spec.rb +9 -0
  193. data/sentry-ruby/spec/spec_helper.rb +49 -0
  194. data/sentry-ruby/spec/support/linecache.txt +6 -0
  195. metadata +160 -31
  196. data/.travis.yml +0 -47
  197. data/docs/Makefile +0 -130
  198. data/docs/breadcrumbs.rst +0 -51
  199. data/docs/conf.py +0 -228
  200. data/docs/config.rst +0 -260
  201. data/docs/context.rst +0 -141
  202. data/docs/index.rst +0 -113
  203. data/docs/install.rst +0 -40
  204. data/docs/integrations/heroku.rst +0 -11
  205. data/docs/integrations/index.rst +0 -59
  206. data/docs/integrations/puma.rst +0 -30
  207. data/docs/integrations/rack.rst +0 -27
  208. data/docs/integrations/rails.rst +0 -62
  209. data/docs/make.bat +0 -155
  210. data/docs/processors.rst +0 -124
  211. data/docs/sentry-doc-config.json +0 -31
  212. data/docs/usage.rst +0 -176
data/.travis.yml DELETED
@@ -1,47 +0,0 @@
1
- language: ruby
2
- dist: trusty
3
- sudo: false
4
- group: beta
5
- cache: bundler
6
-
7
- services:
8
- - redis-server
9
-
10
- branches:
11
- only: [master]
12
-
13
- rvm:
14
- - 2.2.9
15
- - 2.3.6
16
- - 2.4.3
17
- - 2.5.0
18
-
19
- env:
20
- - RAILS_VERSION=4
21
- - RAILS_VERSION=5
22
- - RAILS_VERSION=0
23
-
24
- addons:
25
- apt:
26
- packages:
27
- - haveged
28
-
29
- before_install:
30
- - service haveged start
31
- # Pin bundler version due to https://github.com/rubygems/rubygems/issues/2055
32
- - gem install bundler -v 1.16.0
33
-
34
- matrix:
35
- include:
36
- - rvm: 1.9
37
- env: RAILS_VERSION=4
38
- - rvm: jruby-1.7.27
39
- env: JRUBY_OPTS="--dev" RAILS_VERSION=4
40
- - rvm: jruby-9.1.17.0
41
- env: JRUBY_OPTS="--dev -J-Djruby.launch.inproc=true -J-Xmx1024M" RAILS_VERSION=4
42
- - rvm: jruby-9.1.17.0
43
- env: JRUBY_OPTS="--dev -J-Djruby.launch.inproc=true -J-Xmx1024M" RAILS_VERSION=5
44
- - rvm: ruby-head
45
- env: RAILS_VERSION=0
46
- allow_failures:
47
- - rvm: ruby-head
data/docs/Makefile DELETED
@@ -1,130 +0,0 @@
1
- # Makefile for Sphinx documentation
2
- #
3
-
4
- # You can set these variables from the command line.
5
- SPHINXOPTS =
6
- SPHINXBUILD = sphinx-build
7
- PAPER =
8
- BUILDDIR = ./_build
9
-
10
- # Internal variables.
11
- PAPEROPT_a4 = -D latex_paper_size=a4
12
- PAPEROPT_letter = -D latex_paper_size=letter
13
- ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14
-
15
- .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
16
-
17
- help:
18
- @echo "Please use \`make <target>' where <target> is one of"
19
- @echo " html to make standalone HTML files"
20
- @echo " dirhtml to make HTML files named index.html in directories"
21
- @echo " singlehtml to make a single large HTML file"
22
- @echo " pickle to make pickle files"
23
- @echo " json to make JSON files"
24
- @echo " htmlhelp to make HTML files and a HTML help project"
25
- @echo " qthelp to make HTML files and a qthelp project"
26
- @echo " devhelp to make HTML files and a Devhelp project"
27
- @echo " epub to make an epub"
28
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
30
- @echo " text to make text files"
31
- @echo " man to make manual pages"
32
- @echo " changes to make an overview of all changed/added/deprecated items"
33
- @echo " linkcheck to check all external links for integrity"
34
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
35
-
36
- clean:
37
- -rm -rf $(BUILDDIR)/*
38
-
39
- html:
40
- $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
41
- @echo
42
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
43
-
44
- dirhtml:
45
- $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
46
- @echo
47
- @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
48
-
49
- singlehtml:
50
- $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
51
- @echo
52
- @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
53
-
54
- pickle:
55
- $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
56
- @echo
57
- @echo "Build finished; now you can process the pickle files."
58
-
59
- json:
60
- $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
61
- @echo
62
- @echo "Build finished; now you can process the JSON files."
63
-
64
- htmlhelp:
65
- $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
66
- @echo
67
- @echo "Build finished; now you can run HTML Help Workshop with the" \
68
- ".hhp project file in $(BUILDDIR)/htmlhelp."
69
-
70
- qthelp:
71
- $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
72
- @echo
73
- @echo "Build finished; now you can run "qcollectiongenerator" with the" \
74
- ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
75
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Sentry.qhcp"
76
- @echo "To view the help file:"
77
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Sentry.qhc"
78
-
79
- devhelp:
80
- $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
81
- @echo
82
- @echo "Build finished."
83
- @echo "To view the help file:"
84
- @echo "# mkdir -p $$HOME/.local/share/devhelp/Sentry"
85
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Sentry"
86
- @echo "# devhelp"
87
-
88
- epub:
89
- $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
90
- @echo
91
- @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
92
-
93
- latex:
94
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
95
- @echo
96
- @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
97
- @echo "Run \`make' in that directory to run these through (pdf)latex" \
98
- "(use \`make latexpdf' here to do that automatically)."
99
-
100
- latexpdf:
101
- $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
102
- @echo "Running LaTeX files through pdflatex..."
103
- make -C $(BUILDDIR)/latex all-pdf
104
- @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
105
-
106
- text:
107
- $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
108
- @echo
109
- @echo "Build finished. The text files are in $(BUILDDIR)/text."
110
-
111
- man:
112
- $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
113
- @echo
114
- @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
115
-
116
- changes:
117
- $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
118
- @echo
119
- @echo "The overview file is in $(BUILDDIR)/changes."
120
-
121
- linkcheck:
122
- $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
123
- @echo
124
- @echo "Link check complete; look for any errors in the above output " \
125
- "or in $(BUILDDIR)/linkcheck/output.txt."
126
-
127
- doctest:
128
- $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
129
- @echo "Testing of doctests in the sources finished, look at the " \
130
- "results in $(BUILDDIR)/doctest/output.txt."
data/docs/breadcrumbs.rst DELETED
@@ -1,51 +0,0 @@
1
- .. versionadded:: 1.2
2
-
3
- Breadcrumbs
4
- ===========
5
-
6
- Breadcrumbs are a trail of events which happened prior to an issue. Often, these events are very similar to traditional logs, but Breadcrumbs also can record rich, structured data.
7
-
8
- .. sourcecode:: ruby
9
-
10
- Raven.breadcrumbs.record do |crumb|
11
- crumb.data = data
12
- crumb.category = name
13
- # ...
14
- end
15
-
16
- The following attributes are available:
17
-
18
- * ``category``: A String to label the event under. This will usually be the same as a logger name, and will let you more easily understand the area an event took place, such as "auth".
19
- * ``data``: A Hash of metadata around the event. This is often used instead of message, but may also be used in addition.
20
- * ``level``: The level may be any of ``error``, ``warn``, ``info``, or ``debug``.
21
- * ``message``: A string describing the event. The most common vector, often used as a drop-in for a traditional log message.
22
- * ``timestamp``: A Unix timestamp (seconds past epoch)
23
-
24
- Appropriate places to inject Breadcrumbs may be places like your HTTP library:
25
-
26
- .. sourcecode:: ruby
27
-
28
- # Instrumenting Faraday with a middleware:
29
-
30
- class RavenFaradayMiddleware
31
- def call
32
- # Add a breadcrumb every time we complete an HTTP request
33
- @app.call(request_env).on_complete do |response_env|
34
- Raven.breadcrumbs.record do |crumb|
35
- crumb.data = { response_env: response_env }
36
- crumb.category = "faraday"
37
- crumb.timestamp = Time.now.to_i
38
- crumb.message = "Completed request to #{request_env[:url]}"
39
- end
40
- end
41
- end
42
- end
43
-
44
- .. versionadded:: 2.6
45
-
46
- The breadcrumb buffer is publicly accessible if you wish to manipulate it beyond
47
- what is possible with the ``record`` method.
48
-
49
- .. sourcecode:: ruby
50
-
51
- Raven.breadcrumbs.buffer # Array of breadcrumbs
data/docs/conf.py DELETED
@@ -1,228 +0,0 @@
1
- # -*- coding: utf-8 -*-
2
- #
3
- # Sentry documentation build configuration file, created by
4
- # sphinx-quickstart on Wed Oct 20 16:21:42 2010.
5
- #
6
- # This file is execfile()d with the current directory set to its containing dir.
7
- #
8
- # Note that not all possible configuration values are present in this
9
- # autogenerated file.
10
- #
11
- # All configuration values have a default; values that are commented out
12
- # serve to show the default.
13
-
14
- import os
15
- import sys
16
- import datetime
17
-
18
- # If extensions (or modules to document with autodoc) are in another directory,
19
- # add these directories to sys.path here. If the directory is relative to the
20
- # documentation root, use os.path.abspath to make it absolute, like shown here.
21
- #sys.path.insert(0, os.path.abspath('.'))
22
-
23
- # -- General configuration -----------------------------------------------------
24
-
25
- # If your documentation needs a minimal Sphinx version, state it here.
26
- #needs_sphinx = '1.0'
27
-
28
- # Add any Sphinx extension module names here, as strings. They can be extensions
29
- # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
30
- #extensions = ['sphinxtogithub']
31
- extensions = ['sphinx.ext.intersphinx']
32
-
33
- # Add any paths that contain templates here, relative to this directory.
34
- templates_path = ['_templates']
35
-
36
- # The suffix of source filenames.
37
- source_suffix = '.rst'
38
-
39
- # The encoding of source files.
40
- #source_encoding = 'utf-8-sig'
41
-
42
- # The master toctree document.
43
- master_doc = 'index'
44
-
45
- # General information about the project.
46
- project = u'Raven'
47
- copyright = u'%s, Functional Software Inc.' % datetime.datetime.today().year
48
-
49
- # The version info for the project you're documenting, acts as replacement for
50
- # |version| and |release|, also used in various other places throughout the
51
- # built documents.
52
- #
53
- # The short X.Y version.
54
-
55
- version = __import__('pkg_resources').get_distribution('raven').version
56
- # The full version, including alpha/beta/rc tags.
57
- release = version
58
-
59
- # The language for content autogenerated by Sphinx. Refer to documentation
60
- # for a list of supported languages.
61
- #language = None
62
-
63
- # There are two options for replacing |today|: either, you set today to some
64
- # non-false value, then it is used:
65
- #today = ''
66
- # Else, today_fmt is used as the format for a strftime call.
67
- #today_fmt = '%B %d, %Y'
68
-
69
- # List of patterns, relative to source directory, that match files and
70
- # directories to ignore when looking for source files.
71
- exclude_patterns = ['_build']
72
-
73
- # The reST default role (used for this markup: `text`) to use for all documents.
74
- #default_role = None
75
-
76
- # If true, '()' will be appended to :func: etc. cross-reference text.
77
- #add_function_parentheses = True
78
-
79
- # If true, the current module name will be prepended to all description
80
- # unit titles (such as .. function::).
81
- #add_module_names = True
82
-
83
- # If true, sectionauthor and moduleauthor directives will be shown in the
84
- # output. They are ignored by default.
85
- #show_authors = False
86
-
87
- # The name of the Pygments (syntax highlighting) style to use.
88
- pygments_style = 'sphinx'
89
-
90
- # A list of ignored prefixes for module index sorting.
91
- #modindex_common_prefix = []
92
-
93
- intersphinx_mapping = {
94
- }
95
-
96
-
97
- # -- Options for HTML output ---------------------------------------------------
98
-
99
- # The theme to use for HTML and HTML Help pages. See the documentation for
100
- # a list of builtin themes.
101
- html_theme = 'nature'
102
-
103
- # Theme options are theme-specific and customize the look and feel of a theme
104
- # further. For a list of options available for each theme, see the
105
- # documentation.
106
- # html_theme_options = {}
107
-
108
- # Add any paths that contain custom themes here, relative to this directory.
109
- html_theme_path = ['_themes']
110
-
111
- # The name for this set of Sphinx documents. If None, it defaults to
112
- # "<project> v<release> documentation".
113
- #html_title = None
114
-
115
- # A shorter title for the navigation bar. Default is the same as html_title.
116
- #html_short_title = None
117
-
118
- # The name of an image file (relative to this directory) to place at the top
119
- # of the sidebar.
120
- #html_logo = "_static/logo.png"
121
-
122
- # The name of an image file (within the static path) to use as favicon of the
123
- # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
124
- # pixels large.
125
- #html_favicon = None
126
-
127
- # Add any paths that contain custom static files (such as style sheets) here,
128
- # relative to this directory. They are copied after the builtin static files,
129
- # so a file named "default.css" will overwrite the builtin "default.css".
130
- html_static_path = ['_static']
131
-
132
- # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
133
- # using the given strftime format.
134
- #html_last_updated_fmt = '%b %d, %Y'
135
-
136
- # If true, SmartyPants will be used to convert quotes and dashes to
137
- # typographically correct entities.
138
- #html_use_smartypants = True
139
-
140
- # Custom sidebar templates, maps document names to template names.
141
- #html_sidebars = {}
142
-
143
- # Additional templates that should be rendered to pages, maps page names to
144
- # template names.
145
- #html_additional_pages = {}
146
-
147
- # If false, no module index is generated.
148
- #html_domain_indices = True
149
-
150
- # If false, no index is generated.
151
- #html_use_index = True
152
-
153
- # If true, the index is split into individual pages for each letter.
154
- #html_split_index = False
155
-
156
- # If true, links to the reST sources are added to the pages.
157
- #html_show_sourcelink = True
158
-
159
- # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
160
- #html_show_sphinx = True
161
-
162
- # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
163
- #html_show_copyright = True
164
-
165
- # If true, an OpenSearch description file will be output, and all pages will
166
- # contain a <link> tag referring to it. The value of this option must be the
167
- # base URL from which the finished HTML is served.
168
- #html_use_opensearch = ''
169
-
170
- # This is the file name suffix for HTML files (e.g. ".xhtml").
171
- #html_file_suffix = None
172
-
173
- # Output file base name for HTML help builder.
174
- htmlhelp_basename = 'Ravendoc'
175
-
176
-
177
- # -- Options for LaTeX output --------------------------------------------------
178
-
179
- # The paper size ('letter' or 'a4').
180
- #latex_paper_size = 'letter'
181
-
182
- # The font size ('10pt', '11pt' or '12pt').
183
- #latex_font_size = '10pt'
184
-
185
- # Grouping the document tree into LaTeX files. List of tuples
186
- # (source start file, target name, title, author, documentclass [howto/manual]).
187
- latex_documents = [
188
- ('index', 'Raven.tex', u'Raven Ruby Documentation',
189
- u'David Cramer', 'manual'),
190
- ]
191
-
192
- # The name of an image file (relative to this directory) to place at the top of
193
- # the title page.
194
- #latex_logo = None
195
-
196
- # For "manual" documents, if this is true, then toplevel headings are parts,
197
- # not chapters.
198
- #latex_use_parts = False
199
-
200
- # If true, show page references after internal links.
201
- #latex_show_pagerefs = False
202
-
203
- # If true, show URL addresses after external links.
204
- #latex_show_urls = False
205
-
206
- # Additional stuff for the LaTeX preamble.
207
- #latex_preamble = ''
208
-
209
- # Documents to append as an appendix to all manuals.
210
- #latex_appendices = []
211
-
212
- # If false, no module index is generated.
213
- #latex_domain_indices = True
214
-
215
-
216
- # -- Options for manual page output --------------------------------------------
217
-
218
- # One entry per manual page. List of tuples
219
- # (source start file, name, description, authors, manual section).
220
- man_pages = [
221
- ('index', 'raven', u'Raven Ruby Documentation',
222
- [u'Functional Software Inc.'], 1)
223
- ]
224
-
225
- if os.environ.get('SENTRY_FEDERATED_DOCS') != '1':
226
- sys.path.insert(0, os.path.abspath('_sentryext'))
227
- import sentryext
228
- sentryext.activate()