Merge pull request #19 from axelhahn/fix-singlejob

update docs
axelhahn · Jul 24, 2023 · 501289c · 501289c
2 parents 0cfcddf + d3aff78
commit 501289c
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 4 deletions.
diff --git a/docs/30_Usage/20_Output.md b/docs/30_Usage/20_Output.md
@@ -96,9 +96,9 @@ The flagfile will be touched if a cronjob was finished.
 
 ## joblog
 
-The daily joblog exists for jobs that run several /  many times per day. It stores the Label of a job, the starting time and a result code.
+The daily joblog exists for jobs that run several / many times per day. It stores the Label of a job, the starting time and a result code.
 
-You have the logs of the last 6 weekdays in the log diectory. The log of the 7th day automatically will be removed.
+You have the results and exectime for all started jobs of the last 6 weekdays in the log diectory. The log of the 7th day automatically will be removed.
 
 ```txt
 axel@linux-pc /v/t/cronlogs> pwd
@@ -131,4 +131,4 @@ With a delimter `:` you see these data (values like in the job logs)
 * exectime - execution time of the job in sec
 * ttl - the ttl value
 * rc - return code
-* blockedbypid - when using option SINGLEJOB=1 and a 2nd job will be executed you get the pid that blocked its execution.
+* blockedbypid - optional: when using option SINGLEJOB=1 and a 2nd job will be executed you get the pid that blocked its execution.
diff --git a/docs/30_Usage/50_Cronlog-Sync.md b/docs/30_Usage/50_Cronlog-Sync.md
@@ -148,7 +148,22 @@ Last but not least: You maybe want to start the job on system start - so enable
 ## Logviewer
 
 TODO: 
-on logserver install 
+on a logserver install 
 
 * a webservice with PHP 
 * the viewer <https://git-repo.iml.unibe.ch/iml-open-source/cronlog-viewer> into webroot or any subfolder below webroot
+
+You get a list of all servers and all cronjobs. Here you can filter by server, status or any table column.
+
+![Screenshot: CronlogViewer - jobs of all servers](/images/cronlogviewer_all_servers.png)
+
+1) If you have several instances of the CronlogViewer you can switch between them.
+2) Filter the list by server while typing something. "All" shows all jobs of all servers and you can filter all jobs. By clicking to a servername you get a list of its cronjobs.
+3) Filter by status. This is very useful for the view of all servers: with one click you get all troublemakers
+4) A table of the cronjobs. You see the status of last execution of a cronjob. The table can be filtered or ordered by any column. A click into a row opens a syntax highlighted log viewer.
+
+In the tab "history" is a table of the parsed joblog file that can be ordered and filtered.
+
+In the tab "timeline" you get a graph with a timeline and bars based on the execution time per cronjob (jobs that run longer than 60 sec). So you can find conflicts of jobs that should not run at the same time.
+
+![Screenshot: CronlogViewer - timeline of a server](/images/cronlogviewer_timeline.png)
diff --git a/docs/images/cronlogviewer_all_servers.png b/docs/images/cronlogviewer_all_servers.png
diff --git a/docs/images/cronlogviewer_timeline.png b/docs/images/cronlogviewer_timeline.png