From 1f42996889a05dbb2b621887b468d696a6ab8200 Mon Sep 17 00:00:00 2001 From: Alex Leong Date: Fri, 24 Aug 2018 13:26:35 -0700 Subject: [PATCH] Document tps-reports (#1509) It's not obvious from the name what the tps-reports API endpoint does. Added a few comments to clarify. Signed-off-by: Alex Leong --- web/app/js/components/Tap.jsx | 2 +- web/app/js/components/Top.jsx | 2 +- web/app/js/components/util/ApiHelpers.jsx | 1 + web/srv/server.go | 3 +++ 4 files changed, 6 insertions(+), 2 deletions(-) diff --git a/web/app/js/components/Tap.jsx b/web/app/js/components/Tap.jsx index aa94759dc..af8b91f81 100644 --- a/web/app/js/components/Tap.jsx +++ b/web/app/js/components/Tap.jsx @@ -288,7 +288,7 @@ class Tap extends React.Component { pendingRequests: true }); - let url = "/api/tps-reports?resource_type=all&all_namespaces=true"; + let url = this.api.urlsForResource("all"); this.api.setCurrentRequests([this.api.fetchMetrics(url)]); this.serverPromise = Promise.all(this.api.getCurrentPromises()) .then(rsp => { diff --git a/web/app/js/components/Top.jsx b/web/app/js/components/Top.jsx index d6d92e42d..20688105a 100644 --- a/web/app/js/components/Top.jsx +++ b/web/app/js/components/Top.jsx @@ -98,7 +98,7 @@ class Top extends React.Component { pendingRequests: true }); - let url = "/api/tps-reports?resource_type=all&all_namespaces=true"; + let url = this.api.urlsForResource("all"); this.api.setCurrentRequests([this.api.fetchMetrics(url)]); this.serverPromise = Promise.all(this.api.getCurrentPromises()) .then(rsp => { diff --git a/web/app/js/components/util/ApiHelpers.jsx b/web/app/js/components/util/ApiHelpers.jsx index 076d34f38..7d327ef0b 100644 --- a/web/app/js/components/util/ApiHelpers.jsx +++ b/web/app/js/components/util/ApiHelpers.jsx @@ -97,6 +97,7 @@ const ApiHelpers = (pathPrefix, defaultMetricsWindow = '1m') => { }; const urlsForResource = (type, namespace) => { + // Traffic Performance Summary. This retrieves stats for the given resource. let baseUrl = '/api/tps-reports?resource_type=' + type; return !namespace ? baseUrl + '&all_namespaces=true' : baseUrl + '&namespace=' + namespace; }; diff --git a/web/srv/server.go b/web/srv/server.go index 875f4a5db..27f29e509 100644 --- a/web/srv/server.go +++ b/web/srv/server.go @@ -101,6 +101,9 @@ func NewServer(addr, templateDir, staticDir, uuid, controllerNamespace, webpackD // webapp api routes server.router.GET("/api/version", handler.handleApiVersion) + // Traffic Performance Summary. This route used to be called /api/stat + // but was renamed to avoid triggering ad blockers. + // See: https://github.com/linkerd/linkerd2/issues/970 server.router.GET("/api/tps-reports", handler.handleApiStat) server.router.GET("/api/pods", handler.handleApiPods) server.router.GET("/api/tap", handler.handleApiTap)