feat: support rocketMQ #231

XmchxUp · 2024-12-30T08:44:04Z

Closes #189

vercel · 2024-12-30T08:44:08Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
kyanos	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 3, 2025 6:32am

XmchxUp · 2024-12-31T03:15:04Z

@hengyoush I am currently encountering problems while executing, and there may be issues with the changes I made.

Can you help me take a look?

log.txt

sudo ./kyanos watch rocketmq --debug-output rocketmq --remote-ports 9876,8080 --protocol-log-level 5 
ERRO[0000] load gotls uprobe failed: load program: invalid argument:
        0: R1=ctx() R10=fp0
        ; int probe_entry_tls_conn_read(struct pt_regs* ctx) {
        0: (bf) r8 = r1                       ; R1=ctx() R8_w=ctx()
        ; uint64_t id = bpf_get_current_pid_tgid();
        1: (85) call bpf_get_current_pid_tgid#14      ; R0_w=scalar()
        ; uint32_t tgid = id >> 32;
        2: (77) r0 >>= 32                     ; R0_w=scalar(smin=0,smax=umax=0xffffffff,var_off=(0x0; 0xffffffff))
        ; uint32_t tgid = id >> 32;

XmchxUp · 2024-12-31T03:17:01Z

I forgot to regenerate the BPF directory.

hengyoush · 2024-12-31T03:17:10Z

Have you modified the eBPF code?
Is your code up to date?

this bug has been fixed in main branch, you should update your branch.

XmchxUp · 2024-12-31T03:18:34Z

Have you modified eBPF code? Is your code up to date?

yes，I need try to regenerate it.

…oush#221) * docs: introduce prettier and md-padding to format docs Signed-off-by: spencercjh <[email protected]> * fix: make github alerts work Signed-off-by: spencercjh <[email protected]> * fix: make all markdown extensions work Signed-off-by: spencercjh <[email protected]> * fix: reformat new codes from main Signed-off-by: spencercjh <[email protected]> --------- Signed-off-by: spencercjh <[email protected]>

…d in server side (hengyoush#232) fix: add fallback logic to calculate totaltime when nicin event missed in server side (hengyoush#232)

XmchxUp · 2024-12-31T05:53:04Z

@hengyoush After updated and still have a problem, did my changes affect it?

sudo ./kyanos watch

log.txt

hengyoush · 2024-12-31T05:58:18Z

No worries. I think your changes should not cause this error, this error is only the gotls probe loading failure, will not affect the function you are developing now, I will check this problem later. @XmchxUp

What your kernel version?

XmchxUp · 2024-12-31T06:01:26Z

What your kernel version?

Linux ultraman-desktop 6.8.0-49-generic #49~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Wed Nov 6 17:42:15 UTC 2 x86_64 x86_64 x86_64 GNU/Linux

hengyoush · 2025-01-01T03:34:58Z

I tested your branch on my ubuntu24.04(kernel version: Linux VM-28-8-ubuntu 6.8.0-49-generic #49-Ubuntu SMP PREEMPT_DYNAMIC Mon Nov 4 02:06:24 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux) , but it works fine and gotls probe load successfully. Take a look at assign_arg function in bpf/gotls.bpf.c , is it looks like below ?

static __inline void assign_arg(void* arg, size_t arg_size, struct location_t loc, const void* sp,
                                uint64_t* regs) {
  if (loc.type == kLocationTypeStack) {
    bpf_probe_read(arg, arg_size, sp + loc.offset);
  } else if (loc.type == kLocationTypeRegisters) {
    if (loc.offset >= 0) {
      if (loc.offset <= (1<<10)) {
        bpf_probe_read(arg, arg_size, (char*)regs + loc.offset);
      }
    }
  }
}

ccoVeille · 2025-01-01T10:27:59Z

agent/protocol/rocketmq/rocketmq.go

+}
+
+func (r *RocketMQMessage) FormatToString() string {
+	return fmt.Sprintf("base=[%s] command=[%s] payload=[%s]", r.FrameBase.String(), "todo", r.Body)


Is the TODO here expected?

I mean because it's a draft PR

ccoVeille · 2025-01-01T10:29:29Z

agent/protocol/rocketmq/rocketmq.go

+	if !ok {
+		return protocol.ParseResult{
+			ParseState: protocol.Ignore,
+			ReadBytes:  frameSize,
+		}
+	} else {
+		message.FrameBase = fb
+		return protocol.ParseResult{
+			ParseState:     protocol.Success,
+			ReadBytes:      frameSize,
+			ParsedMessages: []protocol.ParsedMessage{message},
+		}
+	}


It can be simplified

Suggested change

if !ok {

return protocol.ParseResult{

ParseState: protocol.Ignore,

ReadBytes: frameSize,

}

} else {

message.FrameBase = fb

return protocol.ParseResult{

ParseState: protocol.Success,

ReadBytes: frameSize,

ParsedMessages: []protocol.ParsedMessage{message},

}

}

if !ok {

return protocol.ParseResult{

ParseState: protocol.Ignore,

ReadBytes: frameSize,

}

}

message.FrameBase = fb

return protocol.ParseResult{

ParseState: protocol.Success,

ReadBytes: frameSize,

ParsedMessages: []protocol.ParsedMessage{message},

}

ccoVeille · 2025-01-01T10:29:55Z

agent/protocol/rocketmq/rocketmq.go

+}
+
+func (parser *RocketMQStreamParser) parseHeader(headerBody []byte, serializedType byte) (*RocketMQMessage, error) {
+	fmt.Println(serializedType)


This one looks alike a left behind debug

ccoVeille · 2025-01-01T10:30:50Z

agent/protocol/rocketmq/rocketmq.go

+func (parser *RocketMQStreamParser) parseHeader(headerBody []byte, serializedType byte) (*RocketMQMessage, error) {
+	fmt.Println(serializedType)
+	message := &RocketMQMessage{}
+	if serializedType == 0 {


Return the error currently in the else here if serializedType != 0

And simplify the dozen line if statement

ccoVeille · 2025-01-01T10:32:44Z

agent/protocol/rocketmq/rocketmq.go

+	if len(buffer) < 8 {
+		return protocol.ParseResult{
+			ParseState: protocol.NeedsMoreData,
+		}
+	}
+
+	frameSize := int(binary.BigEndian.Uint32(buffer[:4]))
+	if frameSize > len(buffer) {
+		return protocol.ParseResult{ParseState: protocol.NeedsMoreData}
+	}
+
+	headerLength := binary.BigEndian.Uint32(buffer[4:8])
+	headerDataLen := headerLength & 0xFFFFFF
+	serializedType := byte((headerLength >> 24) & 0xFF)
+
+	if len(buffer) < 8+int(headerDataLen) {


Thr 4 and 8 are magical numbers here. I would like to suggest you to add constants

ccoVeille · 2025-01-01T10:33:19Z

agent/protocol/rocketmq/rocketmq.go

+		if len(headerBody) < 18 {
+			return nil, errors.New("invalid header size")
+		}
+
+		message.RequestCode = int16(binary.BigEndian.Uint16(headerBody[:2]))
+		message.LanguageFlag = headerBody[2]
+		message.VersionFlag = int16(binary.BigEndian.Uint16(headerBody[3:5]))
+		message.Opaque = int32(binary.BigEndian.Uint32(headerBody[5:9]))
+		message.RequestFlag = int32(binary.BigEndian.Uint32(headerBody[9:13]))
+		message.RemarkLength = int32(binary.BigEndian.Uint32(headerBody[13:17]))
+
+		if int(message.RemarkLength) > len(headerBody[17:]) {
+			return nil, errors.New("invalid remark length")
+		}
+		message.Remark = headerBody[17 : 17+message.RemarkLength]
+		propertiesStart := 17 + message.RemarkLength


Same here about magical number 3,5,13,17

ccoVeille · 2025-01-01T10:35:48Z

agent/protocol/rocketmq/types.go

+	"kyanos/agent/protocol"
+)
+
+var _ protocol.ParsedMessage = &RocketMQMessage{}


Here you are validating the struct respect the interface.

This one and the previous one you do in the other files could be in tests file.

I'm unsure the compiler clean them in the final binary

Hey @Zxilly

Do you know if we could check that?

Thanks

ccoVeille · 2025-01-01T10:39:07Z

I know

but I did it anyway 😅

XmchxUp · 2025-01-01T10:51:27Z

@ccoVeille Thanks for the REVIEW, but currently in the stage of learning as I go along with the implementation 😅

bpf/protocol_inference.h

hengyoush · 2025-01-04T10:38:37Z

agent/protocol/rocketmq/rocketmq.go

+		common.ProtocolParserLog.Warnf("Unmatched requests remain: %d", len(reqMap))
+	}
+
+	return records


At the end of Match, you need to clean up reqStream and respStream, otherwise, reqStream/respStream will contain requests or responses that have already been matched.:

It is recommended to clear all respStream entries (and also the map) at the end of the Match function because the request is unlikely to appear again.

For reqStream, clean up those that have already been successfully matched.

Additionally, consider removing a request from reqStream if it has not received a response for a long time, such as if it exceeds a certain time without a matched response.

hengyoush · 2025-01-04T11:11:18Z

agent/protocol/rocketmq/rocketmq.go

+	return message, nil
+}
+
+func (r *RocketMQStreamParser) FindBoundary(streamBuffer *buffer.StreamBuffer, messageType protocol.MessageType, startPos int) int {


The judgment here is too simple. There are two suggestions:

Can you add logic similar to protocol inference?

Generally, the response's Opaque corresponds to a request with the same Opaque. So, when finding the boundary, you can check if the response's Opaque has appeared in previous request parsing (you can add a Map in RocketMQStreamParser to record the Opaque of requests that have already appeared, and then clean it in Match). If it has not appeared, it is considered illegal and should continue searching.

update

1e0025c

vercel bot deployed to Preview December 30, 2024 08:44 View deployment

update

fc38964

vercel bot deployed to Preview December 31, 2024 03:11 View deployment

spencercjh and others added 4 commits December 31, 2024 13:26

fix: add fallback logic to calculate totaltime when nicin event misse…

f677d60

…d in server side (hengyoush#232) fix: add fallback logic to calculate totaltime when nicin event missed in server side (hengyoush#232)

test: introduce a script to test flag --comm (hengyoush#222)

537a08a

update

fc80653

vercel bot deployed to Preview December 31, 2024 05:27 View deployment

Merge branch 'hengyoush:main' into xmchx/feat_support_rocketmq

5b99af1

vercel bot deployed to Preview December 31, 2024 05:34 View deployment

ccoVeille reviewed Jan 1, 2025

View reviewed changes

update

d8f722c

vercel bot deployed to Preview January 2, 2025 01:45 View deployment

Merge branch 'hengyoush:main' into xmchx/feat_support_rocketmq

810f58e

vercel bot deployed to Preview January 2, 2025 02:33 View deployment

hengyoush reviewed Jan 2, 2025

View reviewed changes

bpf/protocol_inference.h Outdated Show resolved Hide resolved

update

6f32563

vercel bot deployed to Preview January 2, 2025 07:20 View deployment

update

541008b

vercel bot deployed to Preview January 2, 2025 07:53 View deployment

update

63345cf

vercel bot deployed to Preview January 2, 2025 07:56 View deployment

update

2e22617

vercel bot deployed to Preview January 2, 2025 08:02 View deployment

update

47d46ca

vercel bot deployed to Preview January 3, 2025 02:49 View deployment

Merge branch 'hengyoush:main' into xmchx/feat_support_rocketmq

94a107e

vercel bot deployed to Preview January 3, 2025 02:52 View deployment

update

1b7d62b

vercel bot deployed to Preview January 3, 2025 05:24 View deployment

hengyoush reviewed Jan 3, 2025

View reviewed changes

bpf/protocol_inference.h Outdated Show resolved Hide resolved

update

1b874e7

vercel bot deployed to Preview January 3, 2025 06:32 View deployment

hengyoush reviewed Jan 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support rocketMQ #231

feat: support rocketMQ #231

XmchxUp commented Dec 30, 2024 •

edited

Loading

vercel bot commented Dec 30, 2024 •

edited

Loading

XmchxUp commented Dec 31, 2024

XmchxUp commented Dec 31, 2024

hengyoush commented Dec 31, 2024 •

edited

Loading

XmchxUp commented Dec 31, 2024

XmchxUp commented Dec 31, 2024

hengyoush commented Dec 31, 2024 •

edited

Loading

XmchxUp commented Dec 31, 2024 •

edited

Loading

hengyoush commented Jan 1, 2025

ccoVeille Jan 1, 2025

ccoVeille Jan 1, 2025

ccoVeille Jan 1, 2025

ccoVeille Jan 1, 2025

ccoVeille Jan 1, 2025

ccoVeille Jan 1, 2025

ccoVeille Jan 1, 2025

ccoVeille Jan 1, 2025

ccoVeille commented Jan 1, 2025

XmchxUp commented Jan 1, 2025

hengyoush Jan 4, 2025 •

edited

Loading

hengyoush Jan 4, 2025

feat: support rocketMQ #231

Are you sure you want to change the base?

feat: support rocketMQ #231

Conversation

XmchxUp commented Dec 30, 2024 • edited Loading

vercel bot commented Dec 30, 2024 • edited Loading

XmchxUp commented Dec 31, 2024

XmchxUp commented Dec 31, 2024

hengyoush commented Dec 31, 2024 • edited Loading

XmchxUp commented Dec 31, 2024

XmchxUp commented Dec 31, 2024

hengyoush commented Dec 31, 2024 • edited Loading

XmchxUp commented Dec 31, 2024 • edited Loading

hengyoush commented Jan 1, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ccoVeille commented Jan 1, 2025

XmchxUp commented Jan 1, 2025

hengyoush Jan 4, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

XmchxUp commented Dec 30, 2024 •

edited

Loading

vercel bot commented Dec 30, 2024 •

edited

Loading

hengyoush commented Dec 31, 2024 •

edited

Loading

hengyoush commented Dec 31, 2024 •

edited

Loading

XmchxUp commented Dec 31, 2024 •

edited

Loading

hengyoush Jan 4, 2025 •

edited

Loading