{"action":"created","comment":{"url":"https://api.github.com/repos/runconduit/conduit/pulls/comments/173847352","pull_request_review_id":103103737,"id":173847352,"diff_hunk":"@@ -0,0 +1,69 @@\n++++\n+title = \"Proxy Metrics\"\n+docpage = true\n+[menu.docs]\n+  parent = \"proxy-metrics\"\n++++\n+\n+The Conduit proxy exposes metrics that describe the traffic flowing through the\n+proxy.  These metrics are exposed in Prometheus format on the proxy control port\n+(4190 by default) at the `/metrics` path.  The following metrics will be\n+exposed:\n+\n+### `request_total`\n+\n+A counter of the number of requests the proxy has received.\n+\n+### `request_duration_ms`","path":"doc/proxy-metrics.md","position":17,"original_position":17,"commit_id":"e148e97a1c054b9603c456160d7ec2ab2cf66d6a","original_commit_id":"f3b016432f7c8e0c1f1a08d040ed3fcf2da434f9","user":{"login":"siggy","id":236915,"avatar_url":"https://avatars2.githubusercontent.com/u/236915?v=4","gravatar_id":"","url":"https://api.github.com/users/siggy","html_url":"https://github.com/siggy","followers_url":"https://api.github.com/users/siggy/followers","following_url":"https://api.github.com/users/siggy/following{/other_user}","gists_url":"https://api.github.com/users/siggy/gists{/gist_id}","starred_url":"https://api.github.com/users/siggy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/siggy/subscriptions","organizations_url":"https://api.github.com/users/siggy/orgs","repos_url":"https://api.github.com/users/siggy/repos","events_url":"https://api.github.com/users/siggy/events{/privacy}","received_events_url":"https://api.github.com/users/siggy/received_events","type":"User","site_admin":false},"body":"I'm fine keeping them separate for naming purposes. This is an optimization we can keep in our back pocket if we need to reduce storage pressure on Prometheus.\r\n\r\nTo clarify a couple points:\r\n\r\n> you wouldn't be able to know if requests are in-flight without the total count.\r\n\r\nI think to measure in-flight correctly, we'd want a gauge. With our proposed implementation, I don't think doing `request_total - request_duration_ms_count` would be provide an accurate in-flight count, as collection time and counter increment ordering can occur in a few different ways.\r\n\r\n> Also, the count is absolute counter\r\n\r\nHistogram counters are absolute. It is only at query time where we can optionally provide a time-bound:\r\nhttps://prometheus.io/docs/practices/histograms/#count-and-sum-of-observations","created_at":"2018-03-12T15:53:12Z","updated_at":"2018-03-12T15:53:13Z","html_url":"https://github.com/runconduit/conduit/pull/536#discussion_r173847352","pull_request_url":"https://api.github.com/repos/runconduit/conduit/pulls/536","author_association":"OWNER","_links":{"self":{"href":"https://api.github.com/repos/runconduit/conduit/pulls/comments/173847352"},"html":{"href":"https://github.com/runconduit/conduit/pull/536#discussion_r173847352"},"pull_request":{"href":"https://api.github.com/repos/runconduit/conduit/pulls/536"}},"in_reply_to_id":173562664},"pull_request":{"url":"https://api.github.com/repos/runconduit/conduit/pulls/536","id":173614868,"html_url":"https://github.com/runconduit/conduit/pull/536","diff_url":"https://github.com/runconduit/conduit/pull/536.diff","patch_url":"https://github.com/runconduit/conduit/pull/536.patch","issue_url":"https://api.github.com/repos/runconduit/conduit/issues/536","number":536,"state":"open","locked":false,"title":"Add proxy metrics documentation","user":{"login":"adleong","id":3979810,"avatar_url":"https://avatars0.githubusercontent.com/u/3979810?v=4","gravatar_id":"","url":"https://api.github.com/users/adleong","html_url":"https://github.com/adleong","followers_url":"https://api.github.com/users/adleong/followers","following_url":"https://api.github.com/users/adleong/following{/other_user}","gists_url":"https://api.github.com/users/adleong/gists{/gist_id}","starred_url":"https://api.github.com/users/adleong/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adleong/subscriptions","organizations_url":"https://api.github.com/users/adleong/orgs","repos_url":"https://api.github.com/users/adleong/repos","events_url":"https://api.github.com/users/adleong/events{/privacy}","received_events_url":"https://api.github.com/users/adleong/received_events","type":"User","site_admin":false},"body":"Proposed documentation for the metrics that the Conduit proxy will expose.  We can either commit this as aspirational documentation or wait until it is accurate before committing.\r\n\r\nSigned-off-by: Alex Leong <alex@buoyant.io>","created_at":"2018-03-08T00:41:39Z","updated_at":"2018-03-12T15:53:13Z","closed_at":null,"merged_at":null,"merge_commit_sha":"4832ef21533a9316fc07faf33656ff84ab8d79b9","assignee":{"login":"adleong","id":3979810,"avatar_url":"https://avatars0.githubusercontent.com/u/3979810?v=4","gravatar_id":"","url":"https://api.github.com/users/adleong","html_url":"https://github.com/adleong","followers_url":"https://api.github.com/users/adleong/followers","following_url":"https://api.github.com/users/adleong/following{/other_user}","gists_url":"https://api.github.com/users/adleong/gists{/gist_id}","starred_url":"https://api.github.com/users/adleong/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adleong/subscriptions","organizations_url":"https://api.github.com/users/adleong/orgs","repos_url":"https://api.github.com/users/adleong/repos","events_url":"https://api.github.com/users/adleong/events{/privacy}","received_events_url":"https://api.github.com/users/adleong/received_events","type":"User","site_admin":false},"assignees":[{"login":"adleong","id":3979810,"avatar_url":"https://avatars0.githubusercontent.com/u/3979810?v=4","gravatar_id":"","url":"https://api.github.com/users/adleong","html_url":"https://github.com/adleong","followers_url":"https://api.github.com/users/adleong/followers","following_url":"https://api.github.com/users/adleong/following{/other_user}","gists_url":"https://api.github.com/users/adleong/gists{/gist_id}","starred_url":"https://api.github.com/users/adleong/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adleong/subscriptions","organizations_url":"https://api.github.com/users/adleong/orgs","repos_url":"https://api.github.com/users/adleong/repos","events_url":"https://api.github.com/users/adleong/events{/privacy}","received_events_url":"https://api.github.com/users/adleong/received_events","type":"User","site_admin":false}],"requested_reviewers":[{"login":"briansmith","id":16816,"avatar_url":"https://avatars0.githubusercontent.com/u/16816?v=4","gravatar_id":"","url":"https://api.github.com/users/briansmith","html_url":"https://github.com/briansmith","followers_url":"https://api.github.com/users/briansmith/followers","following_url":"https://api.github.com/users/briansmith/following{/other_user}","gists_url":"https://api.github.com/users/briansmith/gists{/gist_id}","starred_url":"https://api.github.com/users/briansmith/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/briansmith/subscriptions","organizations_url":"https://api.github.com/users/briansmith/orgs","repos_url":"https://api.github.com/users/briansmith/repos","events_url":"https://api.github.com/users/briansmith/events{/privacy}","received_events_url":"https://api.github.com/users/briansmith/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[{"id":795382493,"url":"https://api.github.com/repos/runconduit/conduit/labels/review","name":"review","color":"ededed","default":false}],"milestone":null,"commits_url":"https://api.github.com/repos/runconduit/conduit/pulls/536/commits","review_comments_url":"https://api.github.com/repos/runconduit/conduit/pulls/536/comments","review_comment_url":"https://api.github.com/repos/runconduit/conduit/pulls/comments{/number}","comments_url":"https://api.github.com/repos/runconduit/conduit/issues/536/comments","statuses_url":"https://api.github.com/repos/runconduit/conduit/statuses/e148e97a1c054b9603c456160d7ec2ab2cf66d6a","head":{"label":"runconduit:alex/document-proxy-metrics","ref":"alex/document-proxy-metrics","sha":"e148e97a1c054b9603c456160d7ec2ab2cf66d6a","user":{"login":"runconduit","id":33942733,"avatar_url":"https://avatars2.githubusercontent.com/u/33942733?v=4","gravatar_id":"","url":"https://api.github.com/users/runconduit","html_url":"https://github.com/runconduit","followers_url":"https://api.github.com/users/runconduit/followers","following_url":"https://api.github.com/users/runconduit/following{/other_user}","gists_url":"https://api.github.com/users/runconduit/gists{/gist_id}","starred_url":"https://api.github.com/users/runconduit/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/runconduit/subscriptions","organizations_url":"https://api.github.com/users/runconduit/orgs","repos_url":"https://api.github.com/users/runconduit/repos","events_url":"https://api.github.com/users/runconduit/events{/privacy}","received_events_url":"https://api.github.com/users/runconduit/received_events","type":"Organization","site_admin":false},"repo":{"id":113106184,"name":"conduit","full_name":"runconduit/conduit","owner":{"login":"runconduit","id":33942733,"avatar_url":"https://avatars2.githubusercontent.com/u/33942733?v=4","gravatar_id":"","url":"https://api.github.com/users/runconduit","html_url":"https://github.com/runconduit","followers_url":"https://api.github.com/users/runconduit/followers","following_url":"https://api.github.com/users/runconduit/following{/other_user}","gists_url":"https://api.github.com/users/runconduit/gists{/gist_id}","starred_url":"https://api.github.com/users/runconduit/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/runconduit/subscriptions","organizations_url":"https://api.github.com/users/runconduit/orgs","repos_url":"https://api.github.com/users/runconduit/repos","events_url":"https://api.github.com/users/runconduit/events{/privacy}","received_events_url":"https://api.github.com/users/runconduit/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/runconduit/conduit","description":"Ultralight service mesh for Kubernetes","fork":false,"url":"https://api.github.com/repos/runconduit/conduit","forks_url":"https://api.github.com/repos/runconduit/conduit/forks","keys_url":"https://api.github.com/repos/runconduit/conduit/keys{/key_id}","collaborators_url":"https://api.github.com/repos/runconduit/conduit/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/runconduit/conduit/teams","hooks_url":"https://api.github.com/repos/runconduit/conduit/hooks","issue_events_url":"https://api.github.com/repos/runconduit/conduit/issues/events{/number}","events_url":"https://api.github.com/repos/runconduit/conduit/events","assignees_url":"https://api.github.com/repos/runconduit/conduit/assignees{/user}","branches_url":"https://api.github.com/repos/runconduit/conduit/branches{/branch}","tags_url":"https://api.github.com/repos/runconduit/conduit/tags","blobs_url":"https://api.github.com/repos/runconduit/conduit/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/runconduit/conduit/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/runconduit/conduit/git/refs{/sha}","trees_url":"https://api.github.com/repos/runconduit/conduit/git/trees{/sha}","statuses_url":"https://api.github.com/repos/runconduit/conduit/statuses/{sha}","languages_url":"https://api.github.com/repos/runconduit/conduit/languages","stargazers_url":"https://api.github.com/repos/runconduit/conduit/stargazers","contributors_url":"https://api.github.com/repos/runconduit/conduit/contributors","subscribers_url":"https://api.github.com/repos/runconduit/conduit/subscribers","subscription_url":"https://api.github.com/repos/runconduit/conduit/subscription","commits_url":"https://api.github.com/repos/runconduit/conduit/commits{/sha}","git_commits_url":"https://api.github.com/repos/runconduit/conduit/git/commits{/sha}","comments_url":"https://api.github.com/repos/runconduit/conduit/comments{/number}","issue_comment_url":"https://api.github.com/repos/runconduit/conduit/issues/comments{/number}","contents_url":"https://api.github.com/repos/runconduit/conduit/contents/{+path}","compare_url":"https://api.github.com/repos/runconduit/conduit/compare/{base}...{head}","merges_url":"https://api.github.com/repos/runconduit/conduit/merges","archive_url":"https://api.github.com/repos/runconduit/conduit/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/runconduit/conduit/downloads","issues_url":"https://api.github.com/repos/runconduit/conduit/issues{/number}","pulls_url":"https://api.github.com/repos/runconduit/conduit/pulls{/number}","milestones_url":"https://api.github.com/repos/runconduit/conduit/milestones{/number}","notifications_url":"https://api.github.com/repos/runconduit/conduit/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/runconduit/conduit/labels{/name}","releases_url":"https://api.github.com/repos/runconduit/conduit/releases{/id}","deployments_url":"https://api.github.com/repos/runconduit/conduit/deployments","created_at":"2017-12-04T23:16:56Z","updated_at":"2018-03-12T15:53:12Z","pushed_at":"2018-03-11T22:22:56Z","git_url":"git://github.com/runconduit/conduit.git","ssh_url":"git@github.com:runconduit/conduit.git","clone_url":"https://github.com/runconduit/conduit.git","svn_url":"https://github.com/runconduit/conduit","homepage":"https://conduit.io","size":3855,"stargazers_count":1204,"watchers_count":1204,"language":"Rust","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":62,"mirror_url":null,"archived":false,"open_issues_count":137,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0"},"forks":62,"open_issues":137,"watchers":1204,"default_branch":"master"}},"base":{"label":"runconduit:master","ref":"master","sha":"649e784d9cc365f050d37dcf671c617d813f3d26","user":{"login":"runconduit","id":33942733,"avatar_url":"https://avatars2.githubusercontent.com/u/33942733?v=4","gravatar_id":"","url":"https://api.github.com/users/runconduit","html_url":"https://github.com/runconduit","followers_url":"https://api.github.com/users/runconduit/followers","following_url":"https://api.github.com/users/runconduit/following{/other_user}","gists_url":"https://api.github.com/users/runconduit/gists{/gist_id}","starred_url":"https://api.github.com/users/runconduit/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/runconduit/subscriptions","organizations_url":"https://api.github.com/users/runconduit/orgs","repos_url":"https://api.github.com/users/runconduit/repos","events_url":"https://api.github.com/users/runconduit/events{/privacy}","received_events_url":"https://api.github.com/users/runconduit/received_events","type":"Organization","site_admin":false},"repo":{"id":113106184,"name":"conduit","full_name":"runconduit/conduit","owner":{"login":"runconduit","id":33942733,"avatar_url":"https://avatars2.githubusercontent.com/u/33942733?v=4","gravatar_id":"","url":"https://api.github.com/users/runconduit","html_url":"https://github.com/runconduit","followers_url":"https://api.github.com/users/runconduit/followers","following_url":"https://api.github.com/users/runconduit/following{/other_user}","gists_url":"https://api.github.com/users/runconduit/gists{/gist_id}","starred_url":"https://api.github.com/users/runconduit/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/runconduit/subscriptions","organizations_url":"https://api.github.com/users/runconduit/orgs","repos_url":"https://api.github.com/users/runconduit/repos","events_url":"https://api.github.com/users/runconduit/events{/privacy}","received_events_url":"https://api.github.com/users/runconduit/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/runconduit/conduit","description":"Ultralight service mesh for Kubernetes","fork":false,"url":"https://api.github.com/repos/runconduit/conduit","forks_url":"https://api.github.com/repos/runconduit/conduit/forks","keys_url":"https://api.github.com/repos/runconduit/conduit/keys{/key_id}","collaborators_url":"https://api.github.com/repos/runconduit/conduit/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/runconduit/conduit/teams","hooks_url":"https://api.github.com/repos/runconduit/conduit/hooks","issue_events_url":"https://api.github.com/repos/runconduit/conduit/issues/events{/number}","events_url":"https://api.github.com/repos/runconduit/conduit/events","assignees_url":"https://api.github.com/repos/runconduit/conduit/assignees{/user}","branches_url":"https://api.github.com/repos/runconduit/conduit/branches{/branch}","tags_url":"https://api.github.com/repos/runconduit/conduit/tags","blobs_url":"https://api.github.com/repos/runconduit/conduit/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/runconduit/conduit/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/runconduit/conduit/git/refs{/sha}","trees_url":"https://api.github.com/repos/runconduit/conduit/git/trees{/sha}","statuses_url":"https://api.github.com/repos/runconduit/conduit/statuses/{sha}","languages_url":"https://api.github.com/repos/runconduit/conduit/languages","stargazers_url":"https://api.github.com/repos/runconduit/conduit/stargazers","contributors_url":"https://api.github.com/repos/runconduit/conduit/contributors","subscribers_url":"https://api.github.com/repos/runconduit/conduit/subscribers","subscription_url":"https://api.github.com/repos/runconduit/conduit/subscription","commits_url":"https://api.github.com/repos/runconduit/conduit/commits{/sha}","git_commits_url":"https://api.github.com/repos/runconduit/conduit/git/commits{/sha}","comments_url":"https://api.github.com/repos/runconduit/conduit/comments{/number}","issue_comment_url":"https://api.github.com/repos/runconduit/conduit/issues/comments{/number}","contents_url":"https://api.github.com/repos/runconduit/conduit/contents/{+path}","compare_url":"https://api.github.com/repos/runconduit/conduit/compare/{base}...{head}","merges_url":"https://api.github.com/repos/runconduit/conduit/merges","archive_url":"https://api.github.com/repos/runconduit/conduit/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/runconduit/conduit/downloads","issues_url":"https://api.github.com/repos/runconduit/conduit/issues{/number}","pulls_url":"https://api.github.com/repos/runconduit/conduit/pulls{/number}","milestones_url":"https://api.github.com/repos/runconduit/conduit/milestones{/number}","notifications_url":"https://api.github.com/repos/runconduit/conduit/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/runconduit/conduit/labels{/name}","releases_url":"https://api.github.com/repos/runconduit/conduit/releases{/id}","deployments_url":"https://api.github.com/repos/runconduit/conduit/deployments","created_at":"2017-12-04T23:16:56Z","updated_at":"2018-03-12T15:53:12Z","pushed_at":"2018-03-11T22:22:56Z","git_url":"git://github.com/runconduit/conduit.git","ssh_url":"git@github.com:runconduit/conduit.git","clone_url":"https://github.com/runconduit/conduit.git","svn_url":"https://github.com/runconduit/conduit","homepage":"https://conduit.io","size":3855,"stargazers_count":1204,"watchers_count":1204,"language":"Rust","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":62,"mirror_url":null,"archived":false,"open_issues_count":137,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0"},"forks":62,"open_issues":137,"watchers":1204,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/runconduit/conduit/pulls/536"},"html":{"href":"https://github.com/runconduit/conduit/pull/536"},"issue":{"href":"https://api.github.com/repos/runconduit/conduit/issues/536"},"comments":{"href":"https://api.github.com/repos/runconduit/conduit/issues/536/comments"},"review_comments":{"href":"https://api.github.com/repos/runconduit/conduit/pulls/536/comments"},"review_comment":{"href":"https://api.github.com/repos/runconduit/conduit/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/runconduit/conduit/pulls/536/commits"},"statuses":{"href":"https://api.github.com/repos/runconduit/conduit/statuses/e148e97a1c054b9603c456160d7ec2ab2cf66d6a"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"siggy"}}