Merge pull request #47965 from makortel/patch-8

Fixes to `FWCore/Services` README's

Author: cmsbuild

FWCore/Services/scripts/README.md

@@ -7,8 +7,8 @@ The `edmTracerCompactLogViewer.py` is used to create a human understandable repr
 To create a Tracer file, add the following to a cmsRun configuration
 ```python
 process.add_(cms.Service("Tracer",
-                         useMessageLogger=cms.untracked.bool(False)),
-                         fileName=cms.untracked.string("<name of file>"))
+                         useMessageLogger=cms.untracked.bool(False),
+                         fileName=cms.untracked.string("<name of file>")))
 ```
 Where `"<name of file>"` is whatever name you want to use for the file that will hold the Tracer output. The use of `useMessageLogger=cms.untracked.bool(False)` is optional but does
 help avoid creating a large output from cmsRun.
@@ -29,14 +29,11 @@ If you only want to see the framework transitions and not all the information ab
 Issue the shell command
 ```edmTracerCompactLogViewer.py -w <name of file>```
 
-The script will outut a new file named `data.js`.
+The script will output a new file named `data.json`.
 
 If you only want to see the framework transitions and not all the information about ED or ES modules, you can use the option `-f`.
 You can also have all activities related to each module grouped by using the `-m` option.
 
 #### setup web data
 
-You will need to copy all the files in `$CMSSW_RELEASE_BASE/src/FWCore/Services/web` to a directory you can access from a web browser. Copy the `data.js` file
-created by `edmTracerCompactLogViewer.py` into that same web browser accessible directory. Now you can have your web browser access the `index.html` file.
-
 For directions on how to use the web application, see the [`FWCore/Services/web/README.md`](../web/README.md) file.

FWCore/Services/web/README.md

@@ -1,25 +1,20 @@
 # Interactive Tracer Log Viewer
 
-## Starting the viewer
-
-### standard web server
-If the output of `edmTracerCompactLogViewer.py` and the files from `FWCore/Services/web` have been placed in a directory accessible to a web server, you may just point your browser to the correct URL to run the viewer.
-
-# My HTTP Server
-
-This is a simple HTTP server implemented in Python using the `http.server` module.
+The viewer has a HTTP server component, implemented in Python using the `http.server` module, and a JavaScript client component.
 
 ## Usage
 
-1. Run the server script (`server.py`) using Python.
-2. Access the server in your web browser by navigating to `http://localhost:65432`.
+1. Copy the output of `edmTracerCompactLogViewer.py` and the files from `FWCore/Services/web` into a directory. The server lists all `.json` files in a drop-down list.
+2. Run the server script (`server.py`) using Python.
+3. Access the server in your web browser by navigating to `http://localhost:65432`.
 
 ### Specifying the Port
 
 You can specify the port to serve on by using the `--port` argument:
 
 ```sh
 python server.py --port 8080
+```
 
 ## Viewer layout
 The viewer is composed to two main areas, the top is the timing viewer and at the bottom shows information about a selected time block. The top time viewer is further divided into three parts. On the left is the macro scoping grouping of framework activity types into Global and Stream activities. If the _module centric_ option was chosen then this area is also divided by each module activity which is sorted based on most time used to least time used. At the bottom is the measurement of time since the start of the job. The main area shows the blocks of time spend doing various work within the Framework.

FWCore/Services/web/server.py

@@ -13,7 +13,7 @@ def do_GET(self):
             self.send_response(200)
             self.send_header('Content-type', 'application/json')
             self.end_headers()
-            json_files = [f for f in os.listdir('.') if f.endswith('.json')]
+            json_files = sorted([f for f in os.listdir('.') if f.endswith('.json')])
             self.wfile.write(json.dumps(json_files).encode())
             return