-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
grpc: add ability to compile with or without tracing (#6954)
golang.org/x/net/trace is the only dependency of gRPC Go that depends -- through html/template and text/template -- on reflect's MethodByName. Binaries with MethodByName are not eligible for Go dead code elimination. As of protobuf v1.32.0 combined with Go 1.22, Go protobufs support compilation with dead code elimination. This commit allows users of gRPC Go to also make use of dead code elimination for smaller binary sizes. Signed-off-by: Chris Koch <[email protected]>
- Loading branch information
Showing
5 changed files
with
120 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| //go:build grpcnotrace | ||
|
|
||
| /* | ||
| * | ||
| * Copyright 2024 gRPC authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| package grpc | ||
|
|
||
| // grpcnotrace can be used to avoid importing golang.org/x/net/trace, which in | ||
| // turn enables binaries using gRPC-Go for dead code elimination, which can | ||
| // yield 10-15% improvements in binary size when tracing is not needed. | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| ) | ||
|
|
||
| type notrace struct{} | ||
|
|
||
| func (notrace) LazyLog(x fmt.Stringer, sensitive bool) {} | ||
| func (notrace) LazyPrintf(format string, a ...any) {} | ||
| func (notrace) SetError() {} | ||
| func (notrace) SetRecycler(f func(any)) {} | ||
| func (notrace) SetTraceInfo(traceID, spanID uint64) {} | ||
| func (notrace) SetMaxEvents(m int) {} | ||
| func (notrace) Finish() {} | ||
|
|
||
| func newTrace(family, title string) traceLog { | ||
| return notrace{} | ||
| } | ||
|
|
||
| func newTraceContext(ctx context.Context, tr traceLog) context.Context { | ||
| return ctx | ||
| } | ||
|
|
||
| func newTraceEventLog(family, title string) traceEventLog { | ||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| //go:build !grpcnotrace | ||
|
|
||
| /* | ||
| * | ||
| * Copyright 2024 gRPC authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| package grpc | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| t "golang.org/x/net/trace" | ||
| ) | ||
|
|
||
| func newTrace(family, title string) traceLog { | ||
| return t.New(family, title) | ||
| } | ||
|
|
||
| func newTraceContext(ctx context.Context, tr traceLog) context.Context { | ||
| return t.NewContext(ctx, tr) | ||
| } | ||
|
|
||
| func newTraceEventLog(family, title string) traceEventLog { | ||
| return t.NewEventLog(family, title) | ||
| } |