bpf: make event naming consistent, fix typos (#733)

mmat11 · web-flow · commit 5266845ecbd7 · 2025-10-02T07:52:14.000-07:00
Signed-off-by: Mattia Meleleo &lt;mattia.meleleo@coralogix.com&gt;
diff --git a/bpf/common/common.c b/bpf/common/common.c
@@ -17,8 +17,8 @@
 #include <common/common.h>
 
 // Force emitting struct http_request_trace into the ELF for automatic creation of Golang struct
-const http_request_trace *unused_4 __attribute__((unused));
-const sql_request_trace *unused_3 __attribute__((unused));
+const http_request_trace_t *unused_4 __attribute__((unused));
+const sql_request_trace_t *unused_3 __attribute__((unused));
 const tcp_req_t *unused_5 __attribute__((unused));
 const kafka_client_req_t *unused_6 __attribute__((unused));
 const redis_client_req_t *unused_7 __attribute__((unused));
diff --git a/bpf/common/common.h b/bpf/common/common.h
@@ -52,8 +52,7 @@ enum large_buf_action : u8 {
 
 // Trace of an HTTP call invocation. It is instantiated by the return uprobe and forwarded to the
 // user space through the events ringbuffer.
-// TODO(matt): fix naming
-typedef struct http_request_trace_t {
+typedef struct http_request_trace {
     u8 type; // Must be first
     u8 _pad0[1];
     u16 status;
@@ -70,10 +69,9 @@ typedef struct http_request_trace_t {
     tp_info_t tp;
     connection_info_t conn;
     pid_info pid;
-} http_request_trace;
+} http_request_trace_t;
 
-// TODO(matt): fix naming
-typedef struct sql_request_trace_t {
+typedef struct sql_request_trace {
     u8 type; // Must be first
     u8 _pad[1];
     u16 status;
@@ -83,7 +81,7 @@ typedef struct sql_request_trace_t {
     tp_info_t tp;
     connection_info_t conn;
     unsigned char sql[SQL_MAX_LEN];
-} sql_request_trace;
+} sql_request_trace_t;
 
 typedef struct kafka_client_req {
     u8 type; // Must be first
@@ -194,18 +192,18 @@ typedef struct go_otel_key_value {
 
 #define OTEL_ATTRIBUTE_KEY_MAX_LEN (32)
 #define OTEL_ATTRIBUTE_VALUE_MAX_LEN (128)
-#define OTEL_ATTRUBUTE_MAX_COUNT (16)
+#define OTEL_ATTRIBUTE_MAX_COUNT (16)
 
-typedef struct otel_attirbute {
+typedef struct otel_attribute {
     u16 val_length;
     u8 vtype;
     u8 reserved;
     unsigned char key[OTEL_ATTRIBUTE_KEY_MAX_LEN];
     unsigned char value[OTEL_ATTRIBUTE_VALUE_MAX_LEN];
-} otel_attirbute_t;
+} otel_attribute_t;
 
 typedef struct otel_attributes {
-    otel_attirbute_t attrs[OTEL_ATTRUBUTE_MAX_COUNT];
+    otel_attribute_t attrs[OTEL_ATTRIBUTE_MAX_COUNT];
     u8 valid_attrs;
     u8 _apad;
 } otel_attributes_t;
diff --git a/bpf/common/http_types.h b/bpf/common/http_types.h
@@ -103,7 +103,7 @@ typedef struct http2_grpc_request {
     tp_info_t tp;
 } http2_grpc_request_t;
 
-// Force emitting struct http_request_trace into the ELF for automatic creation of Golang struct
+// Force emitting struct http_info_t and http2_grpc_request_t into the ELF for automatic creation of Golang struct
 const http_info_t *unused __attribute__((unused));
 const http2_grpc_request_t *unused_http2 __attribute__((unused));
 
diff --git a/bpf/gotracer/go_grpc.c b/bpf/gotracer/go_grpc.c
@@ -258,7 +258,7 @@ int obi_uprobe_server_handleStream_return(struct pt_regs *ctx) {
                    st_ptr,
                    grpc_stream_method_ptr_pos);
 
-    http_request_trace *trace = bpf_ringbuf_reserve(&events, sizeof(http_request_trace), 0);
+    http_request_trace_t *trace = bpf_ringbuf_reserve(&events, sizeof(http_request_trace_t), 0);
     if (!trace) {
         bpf_dbg_printk("can't reserve space in the ringbuffer");
         goto done;
@@ -439,7 +439,7 @@ static __always_inline int grpc_connect_done(struct pt_regs *ctx, void *err) {
         goto done;
     }
 
-    http_request_trace *trace = bpf_ringbuf_reserve(&events, sizeof(http_request_trace), 0);
+    http_request_trace_t *trace = bpf_ringbuf_reserve(&events, sizeof(http_request_trace_t), 0);
     if (!trace) {
         bpf_dbg_printk("can't reserve space in the ringbuffer");
         goto done;
diff --git a/bpf/gotracer/go_nethttp.c b/bpf/gotracer/go_nethttp.c
@@ -377,7 +377,7 @@ static __always_inline int serve_http_returns(struct pt_regs *ctx) {
     make_tp_string(tp_buf, &invocation->tp);
     bpf_dbg_printk("tp: %s", tp_buf);
 
-    http_request_trace *trace = bpf_ringbuf_reserve(&events, sizeof(http_request_trace), 0);
+    http_request_trace_t *trace = bpf_ringbuf_reserve(&events, sizeof(http_request_trace_t), 0);
     if (!trace) {
         bpf_dbg_printk("can't reserve space in the ringbuffer");
         goto done;
@@ -571,7 +571,7 @@ int obi_uprobe_roundTripReturn(struct pt_regs *ctx) {
         goto done;
     }
 
-    http_request_trace *trace = bpf_ringbuf_reserve(&events, sizeof(http_request_trace), 0);
+    http_request_trace_t *trace = bpf_ringbuf_reserve(&events, sizeof(http_request_trace_t), 0);
     if (!trace) {
         bpf_dbg_printk("can't reserve space in the ringbuffer");
         goto done;
diff --git a/bpf/gotracer/go_sdk.c b/bpf/gotracer/go_sdk.c
@@ -427,7 +427,7 @@ int obi_uprobe_RecordError(struct pt_regs *ctx) {
                 "valid_attrs %d, len %d, go_str %s", valid_attrs, go_str.len, go_str.str);
 
             if ((go_str.len < OTEL_ATTRIBUTE_KEY_MAX_LEN) &&
-                (valid_attrs < OTEL_ATTRUBUTE_MAX_COUNT)) {
+                (valid_attrs < OTEL_ATTRIBUTE_MAX_COUNT)) {
                 __builtin_memcpy(
                     span->span_attrs.attrs[valid_attrs].key, ERROR_KEY, ERROR_KEY_SIZE);
                 bpf_probe_read_user(span->span_attrs.attrs[valid_attrs].value,
@@ -441,4 +441,4 @@ int obi_uprobe_RecordError(struct pt_regs *ctx) {
     }
 
     return 0;
-}
+}
diff --git a/bpf/gotracer/go_sql.c b/bpf/gotracer/go_sql.c
@@ -84,7 +84,7 @@ int obi_uprobe_queryReturn(struct pt_regs *ctx) {
     }
     bpf_map_delete_elem(&ongoing_sql_queries, &g_key);
 
-    sql_request_trace *trace = bpf_ringbuf_reserve(&events, sizeof(sql_request_trace), 0);
+    sql_request_trace_t *trace = bpf_ringbuf_reserve(&events, sizeof(sql_request_trace_t), 0);
     if (trace) {
         task_pid(&trace->pid);
         trace->type = EVENT_SQL_CLIENT;
diff --git a/bpf/gotracer/types/otel_types.h b/bpf/gotracer/types/otel_types.h
@@ -26,7 +26,7 @@ volatile const u64 attr_type_int64slice;
 volatile const u64 attr_type_float64slice;
 volatile const u64 attr_type_stringslice;
 
-static __always_inline bool set_attr_value(otel_attirbute_t *attr,
+static __always_inline bool set_attr_value(otel_attribute_t *attr,
                                            go_otel_attr_value_t *go_attr_value) {
     u64 vtype = go_attr_value->vtype;
 
@@ -67,11 +67,11 @@ convert_go_otel_attributes(void *attrs_buf, u64 slice_len, otel_attributes_t *en
     go_otel_attr_value_t go_attr_value = {0};
     struct go_string go_str = {0};
     u8 valid_attrs = enc_attrs->valid_attrs;
-    if (valid_attrs >= OTEL_ATTRUBUTE_MAX_COUNT) {
+    if (valid_attrs >= OTEL_ATTRIBUTE_MAX_COUNT) {
         return;
     }
 
-    for (u8 go_attr_index = 0; go_attr_index < OTEL_ATTRUBUTE_MAX_COUNT; go_attr_index++) {
+    for (u8 go_attr_index = 0; go_attr_index < OTEL_ATTRIBUTE_MAX_COUNT; go_attr_index++) {
         if (go_attr_index >= slice_len) {
             break;
         }
@@ -94,7 +94,7 @@ convert_go_otel_attributes(void *attrs_buf, u64 slice_len, otel_attributes_t *en
         // Need to check valid_attrs otherwise the ebpf verifier thinks it's possible to exceed
         // the max register value for a downstream call, even though it's not possible with
         // this same check at the end of the loop.
-        if (valid_attrs >= OTEL_ATTRUBUTE_MAX_COUNT) {
+        if (valid_attrs >= OTEL_ATTRIBUTE_MAX_COUNT) {
             break;
         }
 
@@ -108,7 +108,7 @@ convert_go_otel_attributes(void *attrs_buf, u64 slice_len, otel_attributes_t *en
 
         enc_attrs->attrs[valid_attrs].vtype = go_attr_value.vtype;
         valid_attrs++;
-        if (valid_attrs >= OTEL_ATTRUBUTE_MAX_COUNT) {
+        if (valid_attrs >= OTEL_ATTRIBUTE_MAX_COUNT) {
             // No more space for attributes
             break;
         }
diff --git a/pkg/components/ebpf/common/common.go b/pkg/components/ebpf/common/common.go
@@ -29,13 +29,13 @@ import (
 	"go.opentelemetry.io/obi/pkg/config"
 )
 
-//go:generate $BPF2GO -cc $BPF_CLANG -cflags $BPF_CFLAGS -target amd64,arm64 -type http_request_trace -type sql_request_trace -type http_info_t -type connection_info_t -type http2_grpc_request_t -type tcp_req_t -type kafka_client_req_t -type kafka_go_req_t -type redis_client_req_t -type tcp_large_buffer_t -type otel_span_t -type mongo_go_client_req_t Bpf ../../../../bpf/common/common.c -- -I../../../../bpf
+//go:generate $BPF2GO -cc $BPF_CLANG -cflags $BPF_CFLAGS -target amd64,arm64 -type http_request_trace_t -type sql_request_trace_t -type http_info_t -type connection_info_t -type http2_grpc_request_t -type tcp_req_t -type kafka_client_req_t -type kafka_go_req_t -type redis_client_req_t -type tcp_large_buffer_t -type otel_span_t -type mongo_go_client_req_t Bpf ../../../../bpf/common/common.c -- -I../../../../bpf
 
 // HTTPRequestTrace contains information from an HTTP request as directly received from the
 // eBPF layer. This contains low-level C structures for accurate binary read from ring buffer.
 type (
-	HTTPRequestTrace     BpfHttpRequestTrace
-	SQLRequestTrace      BpfSqlRequestTrace
+	HTTPRequestTrace     BpfHttpRequestTraceT
+	SQLRequestTrace      BpfSqlRequestTraceT
 	BPFHTTPInfo          BpfHttpInfoT
 	BPFConnInfo          BpfConnectionInfoT
 	TCPRequestInfo       BpfTcpReqT

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ int obi_uprobe_queryReturn(struct pt_regs *ctx) {`
`84`	`84`	`}`
`85`	`85`	`bpf_map_delete_elem(&ongoing_sql_queries, &g_key);`
`86`	`86`
`87`		`- sql_request_trace *trace = bpf_ringbuf_reserve(&events, sizeof(sql_request_trace), 0);`
	`87`	`+ sql_request_trace_t *trace = bpf_ringbuf_reserve(&events, sizeof(sql_request_trace_t), 0);`
`88`	`88`	`if (trace) {`
`89`	`89`	`task_pid(&trace->pid);`
`90`	`90`	`trace->type = EVENT_SQL_CLIENT;`