GitHub PullRequestReviewCommentEvent at 2014-08-18 10:15:04
Repository: socorro
Actor: AdrianGaudebert
Payload: {"action":"created","comment":{"url":"https://api.github.com/repos/mozilla/socorro/pulls/comments/16345685","id":16345685,"diff_hunk":"@@ -0,0 +1,238 @@\n+.. index:: elasticsearch\n+\n+.. _elasticsearch-chapter:\n+\n+ElasticSearch\n+=============\n+\n+Features\n+--------\n+\n+Socorro uses elasticsearch as a back-end for several intensive features in the\n+Web app. Here is a list of those features:\n+\n+* Super Search\n+    * probably the most important one, Super Search is an improved search page\n+      that allows you to search through any field you like in the database. It\n+      exposes convenient and powerful operators and allows to build complex\n+      queries. It is also accessible via the public API, allowing users to\n+      build their own tools.\n+    * *example*: https://crash-stats.mozilla.com/search/\n+* Custom Queries\n+    * based on Super Search, this feature allows users to write JSON queries\n+      that are executed directly against elasticsearch. This is a very\n+      sensitive feature that gives unrestricted access to your data. Specific\n+      permissions are needed for users to have access to it.\n+    * *example*: nope, this is not publicly accessible :)\n+* Signature Report\n+    * a replacement for the old ``/report/list/`` page. It is heavily based\n+      on Super Search, and provides useful information about crashes that\n+      share a signature. Features include listing crash reports, listing user\n+      comments, showing aggregation on any field of the database, and there is\n+      more to come.\n+    * *example*: https://crash-stats.mozilla.com/signature/?signature=nsTimeout::~nsTimeout%28%29\n+* Your Crash Reports\n+    * a very simple page based on Super Search that shows the recent crash\n+      reports that contain the user's email address.\n+    * *example*: https://crash-stats.mozilla.com/your-crashes/\n+* Automatic emails\n+    * this feature is very specific to Mozilla's needs. It is a cron job that\n+      regularly send emails to users that crashed. It is based on ExactTarget,\n+      an emailing service. You will probably need to do some code changes if\n+      you intend to use that feature.\n+\n+Supported versions\n+------------------\n+\n+Socorro currently requires **elasticsearch version 0.90.x**. Support for\n+versions 1.x is planned but not done at the time of writing. For up-to-date\n+information, please check `bug 1010239`_.\n+\n+.. _`bug 1010239`: https://bugzilla.mozilla.org/show_bug.cgi?id=1010239\n+\n+Installation\n+------------\n+\n+Installing elasticsearch is well described in this tutorial:\n+`Setting up elasticsearch`_. Socorro doesn't require any particular\n+configuration for elasticsearch. It is however likely that you will want to\n+tweak it to fit your needs, depending on the size of your cluster, the\n+quantity of data you deal with, etc.\n+\n+.. _`Setting up elasticsearch`: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup.html\n+\n+Once elasticsearch is installed, you will want to set up the basic data\n+required by Socorro. There is a script that will do that for you::\n+\n+    $ python scripts/setup_elasticsearch_app.py\n+\n+Use the ``--help`` option to see the different parameters you can use. The only\n+one you should have to change is ``elasticsearch_urls`` to make it reflect\n+your cluster's URLs. If you are running elasticsearch on localhost:9200, the\n+previous command should work as is.\n+\n+This script creates the ``socorro`` index and populates it with some base data\n+required by Super Search and by the processors to generate the elasticsearch\n+mappings they use. See the `Master list of fields`_ section for more\n+information.\n+\n+Configuration\n+-------------\n+\n+Back-end\n+^^^^^^^^\n+\n+Configure the resource\n+**********************\n+\n+The back-end configuration files lie in the ``.../config/`` folder. All","path":"docs/elasticsearch.rst","position":88,"original_position":88,"commit_id":"62a4b1a2f806a4f17a64337022dd5356130312cf","original_commit_id":"62a4b1a2f806a4f17a64337022dd5356130312cf","user":{"login":"AdrianGaudebert","id":328790,"avatar_url":"https://avatars.githubusercontent.com/u/328790?v=2","gravatar_id":"c298cce1a8e008cd013806fa22e3fab7","url":"https://api.github.com/users/AdrianGaudebert","html_url":"https://github.com/AdrianGaudebert","followers_url":"https://api.github.com/users/AdrianGaudebert/followers","following_url":"https://api.github.com/users/AdrianGaudebert/following{/other_user}","gists_url":"https://api.github.com/users/AdrianGaudebert/gists{/gist_id}","starred_url":"https://api.github.com/users/AdrianGaudebert/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AdrianGaudebert/subscriptions","organizations_url":"https://api.github.com/users/AdrianGaudebert/orgs","repos_url":"https://api.github.com/users/AdrianGaudebert/repos","events_url":"https://api.github.com/users/AdrianGaudebert/events{/privacy}","received_events_url":"https://api.github.com/users/AdrianGaudebert/received_events","type":"User","site_admin":false},"body":"That's a thing I took from @twobraids, ``...`` meaning the root of the repo in my understanding. I'll change it for ``./`` instead, that's probably more widely understood. ","created_at":"2014-08-18T10:15:04Z","updated_at":"2014-08-18T10:15:04Z","html_url":"https://github.com/mozilla/socorro/pull/2290#discussion_r16345685","pull_request_url":"https://api.github.com/repos/mozilla/socorro/pulls/2290","_links":{"self":{"href":"https://api.github.com/repos/mozilla/socorro/pulls/comments/16345685"},"html":{"href":"https://github.com/mozilla/socorro/pull/2290#discussion_r16345685"},"pull_request":{"href":"https://api.github.com/repos/mozilla/socorro/pulls/2290"}}},"pull_request":{"url":"https://api.github.com/repos/mozilla/socorro/pulls/2290","id":19797891,"html_url":"https://github.com/mozilla/socorro/pull/2290","diff_url":"https://github.com/mozilla/socorro/pull/2290.diff","patch_url":"https://github.com/mozilla/socorro/pull/2290.patch","issue_url":"https://api.github.com/repos/mozilla/socorro/issues/2290","number":2290,"state":"open","locked":false,"title":"Fixes bug 1010032 - Added documentation about Elasticsearch and features...","user":{"login":"AdrianGaudebert","id":328790,"avatar_url":"https://avatars.githubusercontent.com/u/328790?v=2","gravatar_id":"c298cce1a8e008cd013806fa22e3fab7","url":"https://api.github.com/users/AdrianGaudebert","html_url":"https://github.com/AdrianGaudebert","followers_url":"https://api.github.com/users/AdrianGaudebert/followers","following_url":"https://api.github.com/users/AdrianGaudebert/following{/other_user}","gists_url":"https://api.github.com/users/AdrianGaudebert/gists{/gist_id}","starred_url":"https://api.github.com/users/AdrianGaudebert/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AdrianGaudebert/subscriptions","organizations_url":"https://api.github.com/users/AdrianGaudebert/orgs","repos_url":"https://api.github.com/users/AdrianGaudebert/repos","events_url":"https://api.github.com/users/AdrianGaudebert/events{/privacy}","received_events_url":"https://api.github.com/users/AdrianGaudebert/received_events","type":"User","site_admin":false},"body":"... based on it.\r\n\r\nr? anyone who feels like reading it, the more eyes I get on this the better. I'm mainly thinking about @phrawzty, @peterbe and @bramwelt. ","created_at":"2014-08-14T16:16:59Z","updated_at":"2014-08-18T10:15:04Z","closed_at":null,"merged_at":null,"merge_commit_sha":"868e796f138adedcaa6b059a1891f23fed56fa01","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/mozilla/socorro/pulls/2290/commits","review_comments_url":"https://api.github.com/repos/mozilla/socorro/pulls/2290/comments","review_comment_url":"https://api.github.com/repos/mozilla/socorro/pulls/comments/{number}","comments_url":"https://api.github.com/repos/mozilla/socorro/issues/2290/comments","statuses_url":"https://api.github.com/repos/mozilla/socorro/statuses/62a4b1a2f806a4f17a64337022dd5356130312cf","head":{"label":"AdrianGaudebert:1010032-elasticsearch-documentation","ref":"1010032-elasticsearch-documentation","sha":"62a4b1a2f806a4f17a64337022dd5356130312cf","user":{"login":"AdrianGaudebert","id":328790,"avatar_url":"https://avatars.githubusercontent.com/u/328790?v=2","gravatar_id":"c298cce1a8e008cd013806fa22e3fab7","url":"https://api.github.com/users/AdrianGaudebert","html_url":"https://github.com/AdrianGaudebert","followers_url":"https://api.github.com/users/AdrianGaudebert/followers","following_url":"https://api.github.com/users/AdrianGaudebert/following{/other_user}","gists_url":"https://api.github.com/users/AdrianGaudebert/gists{/gist_id}","starred_url":"https://api.github.com/users/AdrianGaudebert/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AdrianGaudebert/subscriptions","organizations_url":"https://api.github.com/users/AdrianGaudebert/orgs","repos_url":"https://api.github.com/users/AdrianGaudebert/repos","events_url":"https://api.github.com/users/AdrianGaudebert/events{/privacy}","received_events_url":"https://api.github.com/users/AdrianGaudebert/received_events","type":"User","site_admin":false},"repo":{"id":2353068,"name":"socorro","full_name":"AdrianGaudebert/socorro","owner":{"login":"AdrianGaudebert","id":328790,"avatar_url":"https://avatars.githubusercontent.com/u/328790?v=2","gravatar_id":"c298cce1a8e008cd013806fa22e3fab7","url":"https://api.github.com/users/AdrianGaudebert","html_url":"https://github.com/AdrianGaudebert","followers_url":"https://api.github.com/users/AdrianGaudebert/followers","following_url":"https://api.github.com/users/AdrianGaudebert/following{/other_user}","gists_url":"https://api.github.com/users/AdrianGaudebert/gists{/gist_id}","starred_url":"https://api.github.com/users/AdrianGaudebert/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AdrianGaudebert/subscriptions","organizations_url":"https://api.github.com/users/AdrianGaudebert/orgs","repos_url":"https://api.github.com/users/AdrianGaudebert/repos","events_url":"https://api.github.com/users/AdrianGaudebert/events{/privacy}","received_events_url":"https://api.github.com/users/AdrianGaudebert/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/AdrianGaudebert/socorro","description":"Socorro is a server to accept and process Breakpad crash reports. ","fork":true,"url":"https://api.github.com/repos/AdrianGaudebert/socorro","forks_url":"https://api.github.com/repos/AdrianGaudebert/socorro/forks","keys_url":"https://api.github.com/repos/AdrianGaudebert/socorro/keys{/key_id}","collaborators_url":"https://api.github.com/repos/AdrianGaudebert/socorro/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/AdrianGaudebert/socorro/teams","hooks_url":"https://api.github.com/repos/AdrianGaudebert/socorro/hooks","issue_events_url":"https://api.github.com/repos/AdrianGaudebert/socorro/issues/events{/number}","events_url":"https://api.github.com/repos/AdrianGaudebert/socorro/events","assignees_url":"https://api.github.com/repos/AdrianGaudebert/socorro/assignees{/user}","branches_url":"https://api.github.com/repos/AdrianGaudebert/socorro/branches{/branch}","tags_url":"https://api.github.com/repos/AdrianGaudebert/socorro/tags","blobs_url":"https://api.github.com/repos/AdrianGaudebert/socorro/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/AdrianGaudebert/socorro/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/AdrianGaudebert/socorro/git/refs{/sha}","trees_url":"https://api.github.com/repos/AdrianGaudebert/socorro/git/trees{/sha}","statuses_url":"https://api.github.com/repos/AdrianGaudebert/socorro/statuses/{sha}","languages_url":"https://api.github.com/repos/AdrianGaudebert/socorro/languages","stargazers_url":"https://api.github.com/repos/AdrianGaudebert/socorro/stargazers","contributors_url":"https://api.github.com/repos/AdrianGaudebert/socorro/contributors","subscribers_url":"https://api.github.com/repos/AdrianGaudebert/socorro/subscribers","subscription_url":"https://api.github.com/repos/AdrianGaudebert/socorro/subscription","commits_url":"https://api.github.com/repos/AdrianGaudebert/socorro/commits{/sha}","git_commits_url":"https://api.github.com/repos/AdrianGaudebert/socorro/git/commits{/sha}","comments_url":"https://api.github.com/repos/AdrianGaudebert/socorro/comments{/number}","issue_comment_url":"https://api.github.com/repos/AdrianGaudebert/socorro/issues/comments/{number}","contents_url":"https://api.github.com/repos/AdrianGaudebert/socorro/contents/{+path}","compare_url":"https://api.github.com/repos/AdrianGaudebert/socorro/compare/{base}...{head}","merges_url":"https://api.github.com/repos/AdrianGaudebert/socorro/merges","archive_url":"https://api.github.com/repos/AdrianGaudebert/socorro/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/AdrianGaudebert/socorro/downloads","issues_url":"https://api.github.com/repos/AdrianGaudebert/socorro/issues{/number}","pulls_url":"https://api.github.com/repos/AdrianGaudebert/socorro/pulls{/number}","milestones_url":"https://api.github.com/repos/AdrianGaudebert/socorro/milestones{/number}","notifications_url":"https://api.github.com/repos/AdrianGaudebert/socorro/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/AdrianGaudebert/socorro/labels{/name}","releases_url":"https://api.github.com/repos/AdrianGaudebert/socorro/releases{/id}","created_at":"2011-09-09T02:59:03Z","updated_at":"2014-06-25T14:04:03Z","pushed_at":"2014-08-14T16:15:19Z","git_url":"git://github.com/AdrianGaudebert/socorro.git","ssh_url":"git@github.com:AdrianGaudebert/socorro.git","clone_url":"https://github.com/AdrianGaudebert/socorro.git","svn_url":"https://github.com/AdrianGaudebert/socorro","homepage":"https://wiki.mozilla.org/Socorro","size":160755,"stargazers_count":1,"watchers_count":1,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":1,"default_branch":"master"}},"base":{"label":"mozilla:master","ref":"master","sha":"16433ed0884987a35e4119d5f123d017c896ed9f","user":{"login":"mozilla","id":131524,"avatar_url":"https://avatars.githubusercontent.com/u/131524?v=2","gravatar_id":"9ba739c8f3288e256b13553e4d257b5e","url":"https://api.github.com/users/mozilla","html_url":"https://github.com/mozilla","followers_url":"https://api.github.com/users/mozilla/followers","following_url":"https://api.github.com/users/mozilla/following{/other_user}","gists_url":"https://api.github.com/users/mozilla/gists{/gist_id}","starred_url":"https://api.github.com/users/mozilla/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mozilla/subscriptions","organizations_url":"https://api.github.com/users/mozilla/orgs","repos_url":"https://api.github.com/users/mozilla/repos","events_url":"https://api.github.com/users/mozilla/events{/privacy}","received_events_url":"https://api.github.com/users/mozilla/received_events","type":"Organization","site_admin":false},"repo":{"id":2263742,"name":"socorro","full_name":"mozilla/socorro","owner":{"login":"mozilla","id":131524,"avatar_url":"https://avatars.githubusercontent.com/u/131524?v=2","gravatar_id":"9ba739c8f3288e256b13553e4d257b5e","url":"https://api.github.com/users/mozilla","html_url":"https://github.com/mozilla","followers_url":"https://api.github.com/users/mozilla/followers","following_url":"https://api.github.com/users/mozilla/following{/other_user}","gists_url":"https://api.github.com/users/mozilla/gists{/gist_id}","starred_url":"https://api.github.com/users/mozilla/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mozilla/subscriptions","organizations_url":"https://api.github.com/users/mozilla/orgs","repos_url":"https://api.github.com/users/mozilla/repos","events_url":"https://api.github.com/users/mozilla/events{/privacy}","received_events_url":"https://api.github.com/users/mozilla/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/mozilla/socorro","description":"Socorro is a server to accept and process Breakpad crash reports. ","fork":false,"url":"https://api.github.com/repos/mozilla/socorro","forks_url":"https://api.github.com/repos/mozilla/socorro/forks","keys_url":"https://api.github.com/repos/mozilla/socorro/keys{/key_id}","collaborators_url":"https://api.github.com/repos/mozilla/socorro/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/mozilla/socorro/teams","hooks_url":"https://api.github.com/repos/mozilla/socorro/hooks","issue_events_url":"https://api.github.com/repos/mozilla/socorro/issues/events{/number}","events_url":"https://api.github.com/repos/mozilla/socorro/events","assignees_url":"https://api.github.com/repos/mozilla/socorro/assignees{/user}","branches_url":"https://api.github.com/repos/mozilla/socorro/branches{/branch}","tags_url":"https://api.github.com/repos/mozilla/socorro/tags","blobs_url":"https://api.github.com/repos/mozilla/socorro/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/mozilla/socorro/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/mozilla/socorro/git/refs{/sha}","trees_url":"https://api.github.com/repos/mozilla/socorro/git/trees{/sha}","statuses_url":"https://api.github.com/repos/mozilla/socorro/statuses/{sha}","languages_url":"https://api.github.com/repos/mozilla/socorro/languages","stargazers_url":"https://api.github.com/repos/mozilla/socorro/stargazers","contributors_url":"https://api.github.com/repos/mozilla/socorro/contributors","subscribers_url":"https://api.github.com/repos/mozilla/socorro/subscribers","subscription_url":"https://api.github.com/repos/mozilla/socorro/subscription","commits_url":"https://api.github.com/repos/mozilla/socorro/commits{/sha}","git_commits_url":"https://api.github.com/repos/mozilla/socorro/git/commits{/sha}","comments_url":"https://api.github.com/repos/mozilla/socorro/comments{/number}","issue_comment_url":"https://api.github.com/repos/mozilla/socorro/issues/comments/{number}","contents_url":"https://api.github.com/repos/mozilla/socorro/contents/{+path}","compare_url":"https://api.github.com/repos/mozilla/socorro/compare/{base}...{head}","merges_url":"https://api.github.com/repos/mozilla/socorro/merges","archive_url":"https://api.github.com/repos/mozilla/socorro/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/mozilla/socorro/downloads","issues_url":"https://api.github.com/repos/mozilla/socorro/issues{/number}","pulls_url":"https://api.github.com/repos/mozilla/socorro/pulls{/number}","milestones_url":"https://api.github.com/repos/mozilla/socorro/milestones{/number}","notifications_url":"https://api.github.com/repos/mozilla/socorro/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/mozilla/socorro/labels{/name}","releases_url":"https://api.github.com/repos/mozilla/socorro/releases{/id}","created_at":"2011-08-24T19:21:49Z","updated_at":"2014-08-08T22:02:30Z","pushed_at":"2014-08-16T01:30:10Z","git_url":"git://github.com/mozilla/socorro.git","ssh_url":"git@github.com:mozilla/socorro.git","clone_url":"https://github.com/mozilla/socorro.git","svn_url":"https://github.com/mozilla/socorro","homepage":"https://wiki.mozilla.org/Socorro","size":187794,"stargazers_count":183,"watchers_count":183,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":false,"forks_count":94,"mirror_url":null,"open_issues_count":7,"forks":94,"open_issues":7,"watchers":183,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/mozilla/socorro/pulls/2290"},"html":{"href":"https://github.com/mozilla/socorro/pull/2290"},"issue":{"href":"https://api.github.com/repos/mozilla/socorro/issues/2290"},"comments":{"href":"https://api.github.com/repos/mozilla/socorro/issues/2290/comments"},"review_comments":{"href":"https://api.github.com/repos/mozilla/socorro/pulls/2290/comments"},"review_comment":{"href":"https://api.github.com/repos/mozilla/socorro/pulls/comments/{number}"},"commits":{"href":"https://api.github.com/repos/mozilla/socorro/pulls/2290/commits"},"statuses":{"href":"https://api.github.com/repos/mozilla/socorro/statuses/62a4b1a2f806a4f17a64337022dd5356130312cf"}}}}