diff options
| author | Hari Shreedharan <hshreedharan@apache.org> | 2015-05-20 21:13:10 -0500 |
|---|---|---|
| committer | Imran Rashid <irashid@cloudera.com> | 2015-05-20 21:13:10 -0500 |
| commit | a70bf06b790add5f279a69607df89ed36155b0e4 (patch) | |
| tree | 843891f9809c7e2a3a3f7cbdc8bca61e5bc9de93 /docs/monitoring.md | |
| parent | 5196efff53af4965ff216a9d5c0f8b2b4fc98652 (diff) | |
| download | spark-a70bf06b790add5f279a69607df89ed36155b0e4.tar.gz spark-a70bf06b790add5f279a69607df89ed36155b0e4.tar.bz2 spark-a70bf06b790add5f279a69607df89ed36155b0e4.zip | |
[SPARK-7750] [WEBUI] Rename endpoints from `json` to `api` to allow fu…
…rther extension to non-json outputs too.
Author: Hari Shreedharan <hshreedharan@apache.org>
Closes #6273 from harishreedharan/json-to-api and squashes the following commits:
e14b73b [Hari Shreedharan] Rename `getJsonServlet` to `getServletHandler` i
42f8acb [Hari Shreedharan] Import order fixes.
2ef852f [Hari Shreedharan] [SPARK-7750][WebUI] Rename endpoints from `json` to `api` to allow further extension to non-json outputs too.
Diffstat (limited to 'docs/monitoring.md')
| -rw-r--r-- | docs/monitoring.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/monitoring.md b/docs/monitoring.md index 1e0fc15086..e750184990 100644 --- a/docs/monitoring.md +++ b/docs/monitoring.md @@ -178,9 +178,9 @@ Note that the history server only displays completed Spark jobs. One way to sign In addition to viewing the metrics in the UI, they are also available as JSON. This gives developers an easy way to create new visualizations and monitoring tools for Spark. The JSON is available for -both running applications, and in the history server. The endpoints are mounted at `/json/v1`. Eg., -for the history server, they would typically be accessible at `http://<server-url>:18080/json/v1`, and -for a running application, at `http://localhost:4040/json/v1`. +both running applications, and in the history server. The endpoints are mounted at `/api/v1`. Eg., +for the history server, they would typically be accessible at `http://<server-url>:18080/api/v1`, and +for a running application, at `http://localhost:4040/api/v1`. <table class="table"> <tr><th>Endpoint</th><th>Meaning</th></tr> @@ -240,12 +240,12 @@ These endpoints have been strongly versioned to make it easier to develop applic * Individual fields will never be removed for any given endpoint * New endpoints may be added * New fields may be added to existing endpoints -* New versions of the api may be added in the future at a separate endpoint (eg., `json/v2`). New versions are *not* required to be backwards compatible. +* New versions of the api may be added in the future at a separate endpoint (eg., `api/v2`). New versions are *not* required to be backwards compatible. * Api versions may be dropped, but only after at least one minor release of co-existing with a new api version Note that even when examining the UI of a running applications, the `applications/[app-id]` portion is still required, though there is only one application available. Eg. to see the list of jobs for the -running app, you would go to `http://localhost:4040/json/v1/applications/[app-id]/jobs`. This is to +running app, you would go to `http://localhost:4040/api/v1/applications/[app-id]/jobs`. This is to keep the paths consistent in both modes. # Metrics |