{"action":"created","comment":{"url":"https://api.github.com/repos/elastic/beats/pulls/comments/68679073","id":68679073,"diff_hunk":"@@ -16,64 +13,62 @@ metricbeat.modules:\n   enabled: true\n   period: 1s\n   filters:\n-\n-  # Apache hosts\n   hosts: [\"http://127.0.0.1/\"]\n \n #---------------------------- MySQL Status Module ----------------------------\n - module: mysql\n   metricsets: [\"status\"]\n   enabled: true\n   period: 2s\n-\n-  # Host DSN should be defined as \"tcp(127.0.0.1:3306)/\"\n-  # The username and password can either be set in the DSN or for all hosts in username and password config option\n   hosts: [\"root@tcp(127.0.0.1:3306)/\"]\n ------------------------------------------------------------------------------\n \n+//REVIEWERS: Note that I'm (mostly) removing comments from the code examples because we've found in the past that the commments get out of sync very quickly with the config files and become a maintenance problem.\n \n ==== Metricbeat Options\n \n You can specify the following options in the `metricbeat` section of the +{beatname_lc}.yml+ config file. These options\n-are the same for all modules. Each module can have its specific additional configurations.\n-For more details check the docs of each module.\n+are the same for all modules. Each module may have additional configuration options that are specific to that module.\n+See the <<metricbeat-modules>> section for more info about the available modules, the metricsets that they support,\n+and any additional module-specific configuration info.\n \n ===== module\n \n-The name of module that should be enabled.\n+The name of the module to run. \n \n-===== metricset\n-\n-A list of metricsets that should be enabled for the module. Make sure to only list metricsets\n-which are available in the module. It is not possible to reference metricsets from other modules.\n-\n-===== hosts\n+===== metricsets\n \n-A list of hosts to fetch information from. For some metricsets this is optional.\n+A list of metricsets to execute. Make sure that you only list metricsets\n+that are available in the module. It is not possible to reference metricsets from other modules.\n \n ===== enabled\n \n-Boolean value if a the configuration block is enabled. If the configuration option is missing, it\n-is enabled by default.\n+A Boolean value that specifies whether the module is enabled. If you use the default config file, `metricbeat.yml`,\n+the system module is enabled (set to `enabled: true`) by default. If the `enabled` option is missing from the\n+configuration block, the module is enabled by default.\n \n ===== period\n \n-Period on how often the metricsets should be called. This is required.\n+How often the metricsets are executed. If a system is not reachable, Metricbeat returns an error for each period. This setting is required.\n \n+===== hosts\n+\n+A list of hosts to fetch information from. For some metricsets, this setting is optional.\n+\n+===== fields\n \n+A dictionary of fields that will be sent with the metricset event. This setting is optional. \n \n ===== filters\n \n-Each module configuration can have its own filters. More details on how to configure filters can be found here:\n-<<configuration-filter>>.\n+A list of filters to apply to the data generated by the module. For more detail on how to configure\n+filters, see <<configuration-filter>>.\n \n ===== tags","path":"metricbeat/docs/reference/configuration/metricbeat-options.asciidoc","position":87,"original_position":87,"commit_id":"3eaf070ca284e3ec434e5d03e33aab1967614028","original_commit_id":"3eaf070ca284e3ec434e5d03e33aab1967614028","user":{"login":"dedemorton","id":14206422,"avatar_url":"https://avatars.githubusercontent.com/u/14206422?v=3","gravatar_id":"","url":"https://api.github.com/users/dedemorton","html_url":"https://github.com/dedemorton","followers_url":"https://api.github.com/users/dedemorton/followers","following_url":"https://api.github.com/users/dedemorton/following{/other_user}","gists_url":"https://api.github.com/users/dedemorton/gists{/gist_id}","starred_url":"https://api.github.com/users/dedemorton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dedemorton/subscriptions","organizations_url":"https://api.github.com/users/dedemorton/orgs","repos_url":"https://api.github.com/users/dedemorton/repos","events_url":"https://api.github.com/users/dedemorton/events{/privacy}","received_events_url":"https://api.github.com/users/dedemorton/received_events","type":"User","site_admin":false},"body":"Fixed.","created_at":"2016-06-28T00:15:18Z","updated_at":"2016-06-28T00:15:18Z","html_url":"https://github.com/elastic/beats/pull/1902#discussion_r68679073","pull_request_url":"https://api.github.com/repos/elastic/beats/pulls/1902","_links":{"self":{"href":"https://api.github.com/repos/elastic/beats/pulls/comments/68679073"},"html":{"href":"https://github.com/elastic/beats/pull/1902#discussion_r68679073"},"pull_request":{"href":"https://api.github.com/repos/elastic/beats/pulls/1902"}}},"pull_request":{"url":"https://api.github.com/repos/elastic/beats/pulls/1902","id":75079408,"html_url":"https://github.com/elastic/beats/pull/1902","diff_url":"https://github.com/elastic/beats/pull/1902.diff","patch_url":"https://github.com/elastic/beats/pull/1902.patch","issue_url":"https://api.github.com/repos/elastic/beats/issues/1902","number":1902,"state":"open","locked":false,"title":"Add technical edits to metricbeat doc","user":{"login":"dedemorton","id":14206422,"avatar_url":"https://avatars.githubusercontent.com/u/14206422?v=3","gravatar_id":"","url":"https://api.github.com/users/dedemorton","html_url":"https://github.com/dedemorton","followers_url":"https://api.github.com/users/dedemorton/followers","following_url":"https://api.github.com/users/dedemorton/following{/other_user}","gists_url":"https://api.github.com/users/dedemorton/gists{/gist_id}","starred_url":"https://api.github.com/users/dedemorton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dedemorton/subscriptions","organizations_url":"https://api.github.com/users/dedemorton/orgs","repos_url":"https://api.github.com/users/dedemorton/repos","events_url":"https://api.github.com/users/dedemorton/events{/privacy}","received_events_url":"https://api.github.com/users/dedemorton/received_events","type":"User","site_admin":false},"body":"@ruflin Here are the metricbeat edits. I have a few outstanding notes/questions we should discuss:\r\n- I've added some notes and questions to the files as comments. I want to remove these before we merge the PR. Please respond if a response is needed. :-)\r\n- The fields.yml files for Redis and MySQL are missing quite a few descriptions. Is that intentional?\r\n- Can we change the organization of sections within the topics that appear in the Modules section? I think it would work better to have the sections in the following order, but I didn't want to mess too much with the script: the intro, followed by Compatibility, Metricsets, Example Configuration, Module-Specific Configuration Notes  (I renamed this one), and finally Dashboard. \r\n- When I changed the titles of the modules in the fields.yml (to remove \"status\"), the .yml files got updated too. I hope that's OK.\r\n- I used backticks in the fields.yml file because I saw that they were already used. Not sure if that would affect things like the generated templates, but wanted to mention this just in case. \r\n- It sounds like the metricset generator might have some scripts for generating skeleton doc files. These might need to be updated to be consistent with the changes that I made to the sections under Modules.\r\n","created_at":"2016-06-24T08:18:52Z","updated_at":"2016-06-28T00:15:18Z","closed_at":null,"merged_at":null,"merge_commit_sha":"9a4251d07b493fc7752307cdcd2602796a45d94a","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/elastic/beats/pulls/1902/commits","review_comments_url":"https://api.github.com/repos/elastic/beats/pulls/1902/comments","review_comment_url":"https://api.github.com/repos/elastic/beats/pulls/comments{/number}","comments_url":"https://api.github.com/repos/elastic/beats/issues/1902/comments","statuses_url":"https://api.github.com/repos/elastic/beats/statuses/3eaf070ca284e3ec434e5d03e33aab1967614028","head":{"label":"dedemorton:edit_metricbeat_alpha4","ref":"edit_metricbeat_alpha4","sha":"3eaf070ca284e3ec434e5d03e33aab1967614028","user":{"login":"dedemorton","id":14206422,"avatar_url":"https://avatars.githubusercontent.com/u/14206422?v=3","gravatar_id":"","url":"https://api.github.com/users/dedemorton","html_url":"https://github.com/dedemorton","followers_url":"https://api.github.com/users/dedemorton/followers","following_url":"https://api.github.com/users/dedemorton/following{/other_user}","gists_url":"https://api.github.com/users/dedemorton/gists{/gist_id}","starred_url":"https://api.github.com/users/dedemorton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dedemorton/subscriptions","organizations_url":"https://api.github.com/users/dedemorton/orgs","repos_url":"https://api.github.com/users/dedemorton/repos","events_url":"https://api.github.com/users/dedemorton/events{/privacy}","received_events_url":"https://api.github.com/users/dedemorton/received_events","type":"User","site_admin":false},"repo":{"id":47282528,"name":"beats","full_name":"dedemorton/beats","owner":{"login":"dedemorton","id":14206422,"avatar_url":"https://avatars.githubusercontent.com/u/14206422?v=3","gravatar_id":"","url":"https://api.github.com/users/dedemorton","html_url":"https://github.com/dedemorton","followers_url":"https://api.github.com/users/dedemorton/followers","following_url":"https://api.github.com/users/dedemorton/following{/other_user}","gists_url":"https://api.github.com/users/dedemorton/gists{/gist_id}","starred_url":"https://api.github.com/users/dedemorton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dedemorton/subscriptions","organizations_url":"https://api.github.com/users/dedemorton/orgs","repos_url":"https://api.github.com/users/dedemorton/repos","events_url":"https://api.github.com/users/dedemorton/events{/privacy}","received_events_url":"https://api.github.com/users/dedemorton/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/dedemorton/beats","description":"Beats - Lightweight shippers for Elasticsearch & Logstash","fork":true,"url":"https://api.github.com/repos/dedemorton/beats","forks_url":"https://api.github.com/repos/dedemorton/beats/forks","keys_url":"https://api.github.com/repos/dedemorton/beats/keys{/key_id}","collaborators_url":"https://api.github.com/repos/dedemorton/beats/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/dedemorton/beats/teams","hooks_url":"https://api.github.com/repos/dedemorton/beats/hooks","issue_events_url":"https://api.github.com/repos/dedemorton/beats/issues/events{/number}","events_url":"https://api.github.com/repos/dedemorton/beats/events","assignees_url":"https://api.github.com/repos/dedemorton/beats/assignees{/user}","branches_url":"https://api.github.com/repos/dedemorton/beats/branches{/branch}","tags_url":"https://api.github.com/repos/dedemorton/beats/tags","blobs_url":"https://api.github.com/repos/dedemorton/beats/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/dedemorton/beats/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/dedemorton/beats/git/refs{/sha}","trees_url":"https://api.github.com/repos/dedemorton/beats/git/trees{/sha}","statuses_url":"https://api.github.com/repos/dedemorton/beats/statuses/{sha}","languages_url":"https://api.github.com/repos/dedemorton/beats/languages","stargazers_url":"https://api.github.com/repos/dedemorton/beats/stargazers","contributors_url":"https://api.github.com/repos/dedemorton/beats/contributors","subscribers_url":"https://api.github.com/repos/dedemorton/beats/subscribers","subscription_url":"https://api.github.com/repos/dedemorton/beats/subscription","commits_url":"https://api.github.com/repos/dedemorton/beats/commits{/sha}","git_commits_url":"https://api.github.com/repos/dedemorton/beats/git/commits{/sha}","comments_url":"https://api.github.com/repos/dedemorton/beats/comments{/number}","issue_comment_url":"https://api.github.com/repos/dedemorton/beats/issues/comments{/number}","contents_url":"https://api.github.com/repos/dedemorton/beats/contents/{+path}","compare_url":"https://api.github.com/repos/dedemorton/beats/compare/{base}...{head}","merges_url":"https://api.github.com/repos/dedemorton/beats/merges","archive_url":"https://api.github.com/repos/dedemorton/beats/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/dedemorton/beats/downloads","issues_url":"https://api.github.com/repos/dedemorton/beats/issues{/number}","pulls_url":"https://api.github.com/repos/dedemorton/beats/pulls{/number}","milestones_url":"https://api.github.com/repos/dedemorton/beats/milestones{/number}","notifications_url":"https://api.github.com/repos/dedemorton/beats/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/dedemorton/beats/labels{/name}","releases_url":"https://api.github.com/repos/dedemorton/beats/releases{/id}","deployments_url":"https://api.github.com/repos/dedemorton/beats/deployments","created_at":"2015-12-02T19:12:11Z","updated_at":"2015-12-02T19:12:14Z","pushed_at":"2016-06-24T07:58:49Z","git_url":"git://github.com/dedemorton/beats.git","ssh_url":"git@github.com:dedemorton/beats.git","clone_url":"https://github.com/dedemorton/beats.git","svn_url":"https://github.com/dedemorton/beats","homepage":"https://www.elastic.co/products/beats","size":35815,"stargazers_count":0,"watchers_count":0,"language":"Go","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"elastic:master","ref":"master","sha":"2d95eb82c98485b6c5497aff2dc437d4bf0453aa","user":{"login":"elastic","id":6764390,"avatar_url":"https://avatars.githubusercontent.com/u/6764390?v=3","gravatar_id":"","url":"https://api.github.com/users/elastic","html_url":"https://github.com/elastic","followers_url":"https://api.github.com/users/elastic/followers","following_url":"https://api.github.com/users/elastic/following{/other_user}","gists_url":"https://api.github.com/users/elastic/gists{/gist_id}","starred_url":"https://api.github.com/users/elastic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/elastic/subscriptions","organizations_url":"https://api.github.com/users/elastic/orgs","repos_url":"https://api.github.com/users/elastic/repos","events_url":"https://api.github.com/users/elastic/events{/privacy}","received_events_url":"https://api.github.com/users/elastic/received_events","type":"Organization","site_admin":false},"repo":{"id":16554739,"name":"beats","full_name":"elastic/beats","owner":{"login":"elastic","id":6764390,"avatar_url":"https://avatars.githubusercontent.com/u/6764390?v=3","gravatar_id":"","url":"https://api.github.com/users/elastic","html_url":"https://github.com/elastic","followers_url":"https://api.github.com/users/elastic/followers","following_url":"https://api.github.com/users/elastic/following{/other_user}","gists_url":"https://api.github.com/users/elastic/gists{/gist_id}","starred_url":"https://api.github.com/users/elastic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/elastic/subscriptions","organizations_url":"https://api.github.com/users/elastic/orgs","repos_url":"https://api.github.com/users/elastic/repos","events_url":"https://api.github.com/users/elastic/events{/privacy}","received_events_url":"https://api.github.com/users/elastic/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/elastic/beats","description":":tropical_fish: Beats - Lightweight shippers for Elasticsearch & Logstash ","fork":false,"url":"https://api.github.com/repos/elastic/beats","forks_url":"https://api.github.com/repos/elastic/beats/forks","keys_url":"https://api.github.com/repos/elastic/beats/keys{/key_id}","collaborators_url":"https://api.github.com/repos/elastic/beats/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/elastic/beats/teams","hooks_url":"https://api.github.com/repos/elastic/beats/hooks","issue_events_url":"https://api.github.com/repos/elastic/beats/issues/events{/number}","events_url":"https://api.github.com/repos/elastic/beats/events","assignees_url":"https://api.github.com/repos/elastic/beats/assignees{/user}","branches_url":"https://api.github.com/repos/elastic/beats/branches{/branch}","tags_url":"https://api.github.com/repos/elastic/beats/tags","blobs_url":"https://api.github.com/repos/elastic/beats/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/elastic/beats/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/elastic/beats/git/refs{/sha}","trees_url":"https://api.github.com/repos/elastic/beats/git/trees{/sha}","statuses_url":"https://api.github.com/repos/elastic/beats/statuses/{sha}","languages_url":"https://api.github.com/repos/elastic/beats/languages","stargazers_url":"https://api.github.com/repos/elastic/beats/stargazers","contributors_url":"https://api.github.com/repos/elastic/beats/contributors","subscribers_url":"https://api.github.com/repos/elastic/beats/subscribers","subscription_url":"https://api.github.com/repos/elastic/beats/subscription","commits_url":"https://api.github.com/repos/elastic/beats/commits{/sha}","git_commits_url":"https://api.github.com/repos/elastic/beats/git/commits{/sha}","comments_url":"https://api.github.com/repos/elastic/beats/comments{/number}","issue_comment_url":"https://api.github.com/repos/elastic/beats/issues/comments{/number}","contents_url":"https://api.github.com/repos/elastic/beats/contents/{+path}","compare_url":"https://api.github.com/repos/elastic/beats/compare/{base}...{head}","merges_url":"https://api.github.com/repos/elastic/beats/merges","archive_url":"https://api.github.com/repos/elastic/beats/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/elastic/beats/downloads","issues_url":"https://api.github.com/repos/elastic/beats/issues{/number}","pulls_url":"https://api.github.com/repos/elastic/beats/pulls{/number}","milestones_url":"https://api.github.com/repos/elastic/beats/milestones{/number}","notifications_url":"https://api.github.com/repos/elastic/beats/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/elastic/beats/labels{/name}","releases_url":"https://api.github.com/repos/elastic/beats/releases{/id}","deployments_url":"https://api.github.com/repos/elastic/beats/deployments","created_at":"2014-02-05T19:01:02Z","updated_at":"2016-06-27T19:06:53Z","pushed_at":"2016-06-27T20:21:53Z","git_url":"git://github.com/elastic/beats.git","ssh_url":"git@github.com:elastic/beats.git","clone_url":"https://github.com/elastic/beats.git","svn_url":"https://github.com/elastic/beats","homepage":"https://www.elastic.co/products/beats","size":41019,"stargazers_count":2894,"watchers_count":2894,"language":"Go","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":468,"mirror_url":null,"open_issues_count":260,"forks":468,"open_issues":260,"watchers":2894,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/elastic/beats/pulls/1902"},"html":{"href":"https://github.com/elastic/beats/pull/1902"},"issue":{"href":"https://api.github.com/repos/elastic/beats/issues/1902"},"comments":{"href":"https://api.github.com/repos/elastic/beats/issues/1902/comments"},"review_comments":{"href":"https://api.github.com/repos/elastic/beats/pulls/1902/comments"},"review_comment":{"href":"https://api.github.com/repos/elastic/beats/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/elastic/beats/pulls/1902/commits"},"statuses":{"href":"https://api.github.com/repos/elastic/beats/statuses/3eaf070ca284e3ec434e5d03e33aab1967614028"}}}}
{"actor":{"display_login":"dedemorton"}}