Binary log config: `-service/*` exclusion is accepted and silently turned into a per-service rule, so the service is still logged

未关闭 适合新手
#13,155 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@hidingmyname 已经在做这个了。

开始于 2026年11月3日。

  • #13168 来自 @hidingmyname —— 未关闭

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
82/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
java
领域
observability

调研方向

配置解析位于 services/src/main/java/io/grpc/protobuf/services/BinlogHelper.java 中的 FactoryImpl(约第 645-669 行),isServiceGlob 位于第 781-783 行附近。先把报告的测试添加到 BinlogHelperTest 并运行,查看第一个被错误接受的配置。完成的标准是 *,-p.s/*、-p.s/*、-* 和 -p.s/m{h} 都抛出 Illegal log config pattern,并且现有的 BinlogHelperTest 用例仍然全部通过。

由索引模型根据 Issue 内容生成。

描述

bug
What version of gRPC-Java are you using?

master at 15d64a4 (1.86.0-SNAPSHOT); the parsing code is unchanged on current master.

What is your environment?

Linux x86_64, OpenJDK 21.0.2, Gradle 8.14.5 (wrapper).

What did you expect to see?

A binary log config (from GRPC_BINARY_LOG_CONFIG or BinaryLogs.createBinaryLog(sink, configStr)) that contains an exclusion with a wildcard (-p.s/*) or with a {h|m} suffix (-p.s/m{h}) is rejected with IllegalArgumentException("Illegal log config pattern: ..."), like other malformed patterns. gRFC A16 says:

If the pattern is -<service>/<method>, then the specified method must not be logged. The "*" wildcard must not be used for negations, i.e. -<service>/* is not supported.
...
If a pattern is malformed, the gRPC process must refuse to start up

and its grammar defines Excluded-Method -> "-" Full-Method-Name, with no Pattern-Config suffix.

What did you see instead?

Both configs are accepted.

Location (grpc/grpc-java @ 15d64a4):

          } else if (isServiceGlob(methodOrSvc)) {
            // parse config for a service, e.g. "service/*"
            String service = MethodDescriptor.extractFullServiceName(methodOrSvc);
            ...
            perServiceLogs.put(service, createBinaryLog(sink, binlogOptionStr));
            ...
          } else if (methodOrSvc.startsWith("-")) {
            // parse config for a method, e.g. "-service/method"
            String blacklistedMethod = methodOrSvc.substring(1);
            ...
            blacklistedMethods.add(blacklistedMethod);

Problem

  • -p.s/* ends with /*, so it takes the service-glob branch and registers a per-service log for a service literally named -p.s. No exclusion is recorded, so with *,-p.s/* every method of p.s is still logged through the global * rule. The user asked for the service not to be logged, and its headers and messages end up in the binary log without any warning.
  • -* is stored as an exclusion for a method literally named *, which never matches anything.
  • -p.s/m{h} excludes p.s/m as intended, but the {h} suffix (invalid for an exclusion) is silently dropped.

Only the first case changes what gets logged. The other two are malformed configs that are accepted without an error.

Steps to reproduce the bug

Reproduction

Regression test added to BinlogHelperTest:

diff --git a/services/src/test/java/io/grpc/protobuf/services/BinlogHelperTest.java b/services/src/test/java/io/grpc/protobuf/services/BinlogHelperTest.java
--- a/services/src/test/java/io/grpc/protobuf/services/BinlogHelperTest.java
+++ b/services/src/test/java/io/grpc/protobuf/services/BinlogHelperTest.java
@@ -341,6 +341,18 @@ public final class BinlogHelperTest {
     assertNotNull(makeLog("-p.s/blacklisted,p.s/*", "p.s/allowed"));
   }
 
+  @Test
+  public void configBinLog_blacklist_wildcardOrOptionsRejected() {
+    for (String configStr : new String[] {"*,-p.s/*", "-p.s/*", "-*", "-p.s/m{h}"}) {
+      try {
+        new FactoryImpl(sink, configStr);
+        fail("Expected IllegalArgumentException for " + configStr);
+      } catch (IllegalArgumentException expected) {
+        assertThat(expected).hasMessageThat().startsWith("Illegal log config pattern");
+      }
+    }
+  }
+
   private void assertDuplicatelPatternDetected(String factoryConfigStr) {
     try {
       new BinlogHelper.FactoryImpl(sink, factoryConfigStr);

./gradlew :grpc-services:test --tests io.grpc.protobuf.services.BinlogHelperTest -PskipCodegen=true -PskipAndroid=true

BinlogHelperTest > configBinLog_blacklist_wildcardOrOptionsRejected FAILED
    java.lang.AssertionError: Expected IllegalArgumentException for *,-p.s/*
        at org.junit.Assert.fail(Assert.java:89)
        at io.grpc.protobuf.services.BinlogHelperTest.configBinLog_blacklist_wildcardOrOptionsRejected(BinlogHelperTest.java:349)

172 tests completed, 1 failed

Environment:

Already fixed in grpc/grpc-go

PR: https://github.com/grpc/grpc-go/pull/2299 ("binarylog: implement env variable config parsing", merged 2018-09-26T20:03:55Z, merge commit a338994886e). grpc-go's parser for the same A16 config string handles a leading - first and rejects both a * method and a {...} suffix in exclusions.

How grpc-go fixed it (relevant hunks, verbatim):

--- a/internal/binarylog/env_config.go
+++ b/internal/binarylog/env_config.go
@@ -0,0 +1,206 @@
...
+	// "-service/method", blacklist, no * or {} allowed.
+	if config[0] == '-' {
+		s, m, suffix, err := parseMethodConfigAndSuffix(config[1:])
+		if err != nil {
+			return fmt.Errorf("invalid config: %q, %v", config, err)
+		}
+		if m == "*" {
+			return fmt.Errorf("invalid config: %q, %v", config, "* not allowd in blacklist config")
+		}
+		if suffix != "" {
+			return fmt.Errorf("invalid config: %q, %v", config, "header/message limit not allowed in blacklist config")
+		}
+		if err := l.setBlacklist(s + "/" + m); err != nil {
+			return fmt.Errorf("invalid config: %v", err)
+		}
+		return nil
+	}
...

Suggested fix

Reject an exclusion that contains * or has a {...} suffix before the pattern is classified, using the same Illegal log config pattern error as other malformed entries:

diff --git a/services/src/main/java/io/grpc/protobuf/services/BinlogHelper.java b/services/src/main/java/io/grpc/protobuf/services/BinlogHelper.java
--- a/services/src/main/java/io/grpc/protobuf/services/BinlogHelper.java
+++ b/services/src/main/java/io/grpc/protobuf/services/BinlogHelper.java
@@ -635,6 +635,11 @@ final class BinlogHelper {
           if (methodOrSvc.isEmpty()) {
             throw new IllegalArgumentException("Illegal log config pattern: " + configuration);
           }
+          if (methodOrSvc.startsWith("-")
+              && (binlogOptionStr != null || methodOrSvc.contains("*"))) {
+            // An exclusion names exactly one method; '*' and '{...}' are not allowed
+            throw new IllegalArgumentException("Illegal log config pattern: " + configuration);
+          }
           if (methodOrSvc.equals("*")) {
             // parse config for "*"
             checkState(

Verified on 15d64a4 (OpenJDK 21.0.2, Gradle 8.14.5): the test above fails without this patch and passes with it; no other test results change (:grpc-services:test).

I can submit a PR for this.

Checked: searches for binlog blacklist/exclusion wildcard, BinlogHelper config pattern and GRPC_BINARY_LOG_CONFIG exclusions found no existing issue or PR about this.

主要语言
Java
星标
12.1k
派生
4k
平均合并
1 天 20 小时
30 天内合并 PR
43

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

grpc/grpc-java 的其他 Issue

查看 grpc/grpc-java 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。