diff --git a/pages/common/gnomon.md b/pages/common/gnomon.md new file mode 100644 index 0000000000..d3d54136de --- /dev/null +++ b/pages/common/gnomon.md @@ -0,0 +1,23 @@ +# gnomon + +> Utility to annotate console logging statements with timestamps and find slow processes. + +- Use UNIX (or DOS) pipes to pipe the stdout of any command through gnomon: + +`{{npm test}} | gnomon` + +- Show number of seconds since the start of the process: + +`{{npm test}} | gnomon --type=elapsed-total` + +- Show an absolute timestamp in UTC: + +`{{npm test}} | gnomon --type=absolute` + +- Set a high threshold of 0.5 seconds for the elapsed time; exceeding which the timestamp will be colored bright red: + +`{{npm test}} | gnomon --high {{0.5}}` + +- Set a medium threshold of 0.2 seconds (Timestamp will be colored bright yellow): + +`{{npm test}} | gnomon --medium {{0.2}}`