Merge pull request #1 from pyroscope-io/feature/nettrace

NetTrace stream decoder

Author: kolesnikovae

README.md

@@ -1,12 +1,14 @@
 # .Net diagnostics
 
-*Work In Progress*
-
 The package provides means for .Net runtime diagnostics implemented in Golang:
  - [Diagnostics IPC Protocol](https://github.com/dotnet/diagnostics/blob/main/documentation/design-docs/ipc-protocol.md#transport) client.
  - [NetTrace](https://github.com/microsoft/perfview/blob/main/src/TraceEvent/EventPipe/EventPipeFormat.md) decoder.
 
-### Diagnostics IPC Protocol Client
+### Diagnostic IPC Client
+
+```
+# go get github.com/pyroscope-io/dotnetdiag
+```
 
 Supported .Net versions:
  - .Net 5.0
@@ -26,4 +28,17 @@ Implemented commands:
  - [ ] ProcessInfo
  - [ ] ResumeRuntime
 
-See [examples](examples) directory. 
+### NetTrace decoder
+
+```
+# go get github.com/pyroscope-io/dotnetdiag/nettrace
+```
+
+Supported format versions: <= 4
+
+The decoder deserializes `NetTrace` binary stream to the object sequence. The package also provides an example stream
+handler implementation which processes **Microsoft-DotNETCore-SampleProfiler**
+events: [github.com/pyroscope-io/dotnetdiag/nettrace/profiler](github.com/pyroscope-io/dotnetdiag/nettrace/profiler).
+
+See [examples](examples) directory.
+

client.go

@@ -116,6 +116,5 @@ func (s *Session) Read(b []byte) (int, error) {
 }
 
 func (s *Session) Close() error {
-	// TODO: close session conn?
 	return s.c.StopTracing(s.ID)
 }

client_unix.go

@@ -2,7 +2,13 @@
 
 package dotnetdiag
 
-import "net"
+import (
+	"fmt"
+	"net"
+	"os"
+	"path/filepath"
+	"sort"
+)
 
 func dial(addr string) (net.Conn, error) {
 	ua := &net.UnixAddr{
@@ -15,3 +21,12 @@ func dial(addr string) (net.Conn, error) {
 	}
 	return conn, nil
 }
+
+func DefaultServerAddress(pid int) string {
+	paths, err := filepath.Glob(fmt.Sprintf("%s/dotnet-diagnostic-%d-*-socket", os.TempDir(), pid))
+	if err != nil || len(paths) == 0 {
+		return ""
+	}
+	sort.Slice(paths, func(i, j int) bool { return paths[i] > paths[j] })
+	return paths[0]
+}

dotnetdiag.go

@@ -19,16 +19,6 @@ var (
 // DOTNET_IPC_V1 magic header.
 var magic = [...]byte{0x44, 0x4F, 0x54, 0x4E, 0x45, 0x54, 0x5f, 0x49, 0x50, 0x43, 0x5F, 0x56, 0x31, 0x00}
 
-// Header ...
-// size = 14 + 2 + 1 + 1 + 2 = 20 bytes
-// struct IpcHeader
-// {
-// 	uint8_t[14]  magic = "DOTNET_IPC_V1";
-// 	uint16_t     size;        // size of packet = size of header + payload
-// 	uint8_t      command_set; // combined with command_id is the Command to invoke
-// 	uint8_t      command_id;  // combined with command_set is the Command to invoke
-// 	uint16_t     reserved;    // for potential future use
-// };
 type Header struct {
 	Magic      [14]uint8
 	Size       uint16
@@ -39,18 +29,6 @@ type Header struct {
 
 const headerSize = 20
 
-// CommandSet ...
-// enum class CommandSet : uint8_t
-// {
-//   // reserved = 0x00,
-//   Dump        = 0x01,
-//   EventPipe   = 0x02,
-//   Profiler    = 0x03,
-//   Process     = 0x04,
-//   // future
-//
-//   Server = 0xFF,
-// };
 const (
 	_ = iota
 	CommandSetDump
@@ -61,13 +39,6 @@ const (
 	CommandSetServer = 0xFF
 )
 
-// enum class EventPipeCommandId : uint8_t
-// {
-//   // reserved = 0x00,
-//   StopTracing     = 0x01, // stop a given session
-//   CollectTracing  = 0x02, // create/start a given session
-//   CollectTracing2 = 0x03, // create/start a given session with/without rundown
-// }
 const (
 	_ = iota
 	EventPipeStopTracing

examples/tracing/README.md

@@ -1,26 +1,16 @@
 # Collect Tracing
 
-The example demonstrates how the package may be used to collect NetTrace stream data using Diagnostics IPC:
-the program streams traces produced with `Microsoft-DotNETCore-SampleProfiler` provider to a file.
+The example demonstrates how the package may be used to collect and process `NetTrace` stream data using Diagnostics IPC:
+the program processes events produced with **Microsoft-DotNETCore-SampleProfiler** provider and creates a sampled profile,
+rendered as a call tree.
 
 1. Run dotnet application.
 2. Find its PID, e.g.:
    ```
    # dotnet-trace ps
    ```
 
-3. Find Diagnostics IPC socket/pipe created by the application, e.g.:
-    - Linux/MacOS:
-      ```
-      # lsof -p {PID} | grep dotnet-diagnostic
-      ```
-
-4. Run the example program:
-   ```
-   # collect -s {absolute-path-to-socket} -o {path-to-nettrace-output-file}
-   ```   
-
-5. (Optional) Verify output file:
+3. Build and run the example program:
    ```
-   # dotnet-trace convert --format speedscope -o {path-to-output-file} {path-to-nettrace-file}
+   # go run ./examples/tracing -p {pid}
    ```

examples/tracing/collect.go

@@ -2,35 +2,30 @@ package main
 
 import (
 	"flag"
+	"fmt"
 	"io"
 	"log"
 	"os"
 	"os/signal"
+	"strconv"
+	"strings"
 
 	"github.com/pyroscope-io/dotnetdiag"
+	"github.com/pyroscope-io/dotnetdiag/nettrace"
+	"github.com/pyroscope-io/dotnetdiag/nettrace/profiler"
 )
 
 func main() {
-	var (
-		socketFilePath string
-		outputFilePath = "my-traces.nettrace"
-	)
-
-	flag.StringVar(&socketFilePath, "s", "", "Path to Diagnostic IPC socket")
-	flag.StringVar(&outputFilePath, "o", "my-traces.nettrace", "Output file.")
+	var ps string
+	flag.StringVar(&ps, "p", "", "Target process ID")
 	flag.Parse()
 
-	if socketFilePath == "" {
-		log.Fatalln("Diagnostic IPC socket path is required.")
-	}
-
-	file, err := os.Create(outputFilePath)
+	pid, err := strconv.Atoi(ps)
 	if err != nil {
-		log.Fatalln(err)
+		log.Fatalln("Invalid PID:", err)
 	}
-	defer file.Close()
 
-	c := dotnetdiag.NewClient(socketFilePath)
+	c := dotnetdiag.NewClient(dotnetdiag.DefaultServerAddress(pid))
 	ctc := dotnetdiag.CollectTracingConfig{
 		CircularBufferSizeMB: 10,
 		Providers: []dotnetdiag.ProviderConfig{
@@ -57,9 +52,45 @@ func main() {
 		}
 	}()
 
-	if _, err = io.Copy(file, sess); err != nil {
+	// Process the stream with the sample profiler.
+	stream := nettrace.NewStream(sess)
+	trace, err := stream.Open()
+	if err != nil {
+		_ = sess.Close()
 		log.Fatalln(err)
 	}
 
-	log.Println("Done")
+	p := profiler.NewSampleProfiler(trace)
+	stream.EventHandler = p.EventHandler
+	stream.MetadataHandler = p.MetadataHandler
+	stream.StackBlockHandler = p.StackBlockHandler
+	stream.SequencePointBlockHandler = p.SequencePointBlockHandler
+
+	log.Println("Collecting trace log")
+	for {
+		switch err = stream.Next(); err {
+		default:
+			log.Fatalln(err)
+		case nil:
+			continue
+		case io.EOF:
+			p.Walk(treePrinter(os.Stdout))
+			log.Println("Done")
+			return
+		}
+	}
+}
+
+func treePrinter(w io.Writer) func(profiler.FrameInfo) {
+	return func(frame profiler.FrameInfo) {
+		_, _ = fmt.Fprintf(w, "%s(%v) %s\n", padding(frame.Level), frame.SampledTime, frame.Name)
+	}
+}
+
+func padding(x int) string {
+	var s strings.Builder
+	for i := 0; i < x; i++ {
+		s.WriteString("\t")
+	}
+	return s.String()
 }