Skip to content

Commit 1f3fb4d

Browse files
committed
docs: remove TODO section from README
1 parent fe47b66 commit 1f3fb4d

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,20 @@ See [splunk](pkg/splunk) source or [package documentation](https://pkg.go.dev/gi
109109

110110
### strc - simple tracing via slog
111111

112+
A small utility that accepts JSON from Splunk/Kibana/Cloudwatch and generates a text stack with timing information or a SVG flame graph. See [example_cli](internal/example_cli/main.go) and [example_export](internal/example_export/main.go) for fully working examples. To see it in action:
113+
114+
```
115+
go run github.com/osbuild/logging/internal/example_cli/
116+
```
117+
118+
See [strc](pkg/strc/stgraph) source or [package documentation](https://pkg.go.dev/github.com/osbuild/logging/pkg/strc/stgraph) for more info.
119+
120+
The generated SVG file is interactive and one can drill down the stack with a mouse click, the file needs to be opened in a new browser panel tho:
121+
122+
[![Example](pkg/strc/stgraph/graph.svg)](pkg/strc/stgraph/graph.svg)
123+
124+
### strc/stgraph - simple tracing data processor
125+
112126
See [example_print](internal/example_print/main.go) and [example_export](internal/example_export/main.go) for fully working examples. To see it in action:
113127

114128
```
@@ -272,7 +286,3 @@ make unit-tests
272286
License: MIT
273287

274288
Most code in `splunk` package was ported from https://github.com/osbuild/osbuild-composer and some code in `strc` from https://github.com/samber/slog-http
275-
276-
## TODO
277-
278-
* CLI tool for analyzing data from Splunk.

pkg/strc/stgraph/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Then install flamegraph utility (package for Fedora available) and run:
3838
flamegraph.pl /tmp/graph.unfolded > graph.svg
3939
```
4040

41-
Result (click to zoom):
41+
The generated SVG file is interactive and one can drill down the stack with a mouse click, the file needs to be opened in a new browser panel tho:
4242

4343
[![Example](graph.svg)](graph.svg)
4444

0 commit comments

Comments
 (0)