Go to file
AJ Heller c9fdef1317 [logging] Centralize configuration for trace flags (#36576)
All TraceFlags are now configured in `src/core/lib/debug/trace_flags.yaml`. The format is:

```
my_flag:
  default: false                   # the default value; default=false
  description: Some Description
  debug_only: false                # debug_only flags only work in debug builds; default=false
  internal: false                  # internal flags will not show up in documentation; default=false
```

To regenerate the trace flag source code, run `tools/codegen/core/gen_trace_flags.py` (requires mako). This script is also run when sanity checking.

This PR also adds two new features:

### Glob-based flag configuration

Trace flag configuration now supports `?` (single wildcard character) and `*` (one or more wildcard characters).  For example, using `GRPC_TRACE='event_engine*'` will enable all flags that match that glob. It expands to:

* event_engine
* event_engine_client_channel_resolver
* event_engine_dns
* event_engine_endpoint
* event_engine_endpoint_data
* event_engine_poller

### A cleaner trace-logging macro in abseil logging format

If your goal is only to add log statements when the `fault_injection_filter` trace flag is enabled, you can use the macro:

```
GRPC_TRACE_LOG(fault_injection, INFO) << "Filtered:" << 42;
```

When the trace flag is enabled, the the log will show something like this:
```
I0000 00:00:1715733657.430042      16 file.cc:174] Filtered:42
```

----

Note: just like with the gpr_log to abseil logging conversion, the pre-existing trace logging usages can be replaced with the new tracing macro across multiple PRs.

Closes #36576

PiperOrigin-RevId: 641295215
2024-06-07 10:47:38 -07:00
.bazelci [test-infra] Update all Ubuntu docker images to v20.04 or newer (#35440) 2024-01-03 15:14:54 -08:00
.github Bump the github-actions group with 4 updates (#36495) 2024-05-21 12:58:23 -07:00
bazel [build] Support clang-cl for Windows builds (best effort) (#36831) 2024-06-06 13:54:12 -07:00
cmake [OTel] Add find_package call for OTel dependency in installed gRPC configuration (#36674) 2024-05-21 16:46:02 -07:00
doc [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
etc Update root pem certs (#27539) 2021-10-01 04:46:12 -07:00
examples [build] rename android platforms to match CPU arch (#36715) 2024-06-06 10:20:05 -07:00
fuzztest [metadata] Remove arena from `grpc_metadata_batch` constructor (#36118) 2024-04-01 11:23:54 -07:00
include [grpc][Gpr_To_Absl_Logging] Deleting multiple instances of gpr_set_log_function (#36833) 2024-06-07 09:14:44 -07:00
spm-core-include Support swift package manager for grpc-core and grpc-cpp. 2020-10-28 14:53:37 -07:00
spm-cpp-include Support swift package manager for grpc-core and grpc-cpp. 2020-10-28 14:53:37 -07:00
src [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
summerofcode Update .cc and .md files 2019-01-30 11:24:09 -05:00
templates [Interop] Test grpc-go 1.64 using go 1.22 runtime (#36755) 2024-06-07 09:31:49 -07:00
test [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
third_party [build] Support clang-cl for Windows builds (best effort) (#36831) 2024-06-06 13:54:12 -07:00
tools [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
.bazelignore [Misc] Added third_party/utf8_range to .bazelignore (#36054) 2024-03-06 08:31:48 -08:00
.bazelrc Add suggested alias for bazelrc import location 2018-10-24 23:31:54 +02:00
.bazelversion [CI] Moved to Bazel 7 (#36105) 2024-03-20 16:16:12 -07:00
.clang-format [clang-format] Remove requirement that port_platform.h is at the top (#36281) 2024-04-09 08:58:34 -07:00
.clang-tidy [CI] Using clang-17 for clang tidy & format (#35595) 2024-01-23 10:19:25 -08:00
.dockerignore [Interop test] Install curl (#33982) 2023-08-03 14:57:41 -07:00
.editorconfig Adding an editorconfig configuration file. 2015-01-31 06:43:40 +01:00
.git-blame-ignore-revs [git] Ignore python style LSC #33138 in git blame (#33396) 2023-06-09 17:00:22 -07:00
.gitallowed .gitallowed modification on the path of test files. 2020-02-26 15:15:40 -08:00
.gitattributes [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
.gitignore [Build] Prepared for Bazel 7 (#35374) 2023-12-21 13:02:38 -08:00
.gitmodules [OTel] Add OTel C++ as a submodule (#36032) 2024-02-29 18:06:02 -08:00
.istanbul.yml Moved gRPC node package root to repo root, made it depend on grpc.gyp 2015-10-01 11:54:00 -07:00
.pylintrc [PSM interop] Introduce isort/pylint to the GKE framework (#29476) 2022-05-03 11:05:04 -07:00
.pylintrc-examples Update third_party/protobuf to 3.21.4 (#30377) 2022-08-04 09:39:49 -07:00
.pylintrc-tests [PSM interop] Introduce isort/pylint to the GKE framework (#29476) 2022-05-03 11:05:04 -07:00
.rspec Bundled C core with Ruby library 2015-12-18 11:18:34 -08:00
.yapfignore More pythons to be formatted 2020-01-03 22:21:23 -08:00
.yardopts Adding a .yardopts file at the root so rubydocs isn't getting lost. 2016-02-13 22:54:23 +01:00
AUTHORS [Aio] Unary unary client call barebones implementation 2019-09-11 20:37:45 +02:00
BUILD [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
BUILDING.md Fixed bazel tests for 7 (#35390) 2023-12-26 10:30:45 -08:00
BoringSSL-Package.swift [BoringSSL] Update third_party/boringssl-with-bazel (#36716) 2024-05-29 10:46:22 -07:00
CMakeLists.txt [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
CODE-OF-CONDUCT.md Fix code of conduct 2017-06-08 13:15:06 -07:00
CONCEPTS.md Tiny update to protocol overview doc. (#26396) 2021-09-07 14:07:56 -07:00
CONTRIBUTING.md Update note on closed feature requests with help wanted label 2020-05-05 01:13:27 -07:00
CONTRIBUTING_STEPS.md Writing a doc with steps to contribute to the grpc code base. 2024-02-06 00:31:06 -08:00
GOVERNANCE.md Add GOVERNANCE.md 2019-09-20 11:38:05 -07:00
Gemfile Bundled C core with Ruby library 2015-12-18 11:18:34 -08:00
LICENSE include full text of MPLv2 license in /LICENSE (#30115) 2022-06-29 19:13:23 +02:00
MAINTAINERS.md Adding id for grpc access (#36391) 2024-05-28 13:26:27 -07:00
MANIFEST.md Abstract libuv implementation 2018-03-13 01:21:42 -07:00
Makefile [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
NOTICE.txt change LICENSE, add AUTHORS 2017-06-08 11:22:40 +02:00
PYTHON-MANIFEST.in [protobuf] Upgrade third_party/protobuf to 22.x (#32606) 2023-04-12 18:43:58 +02:00
Package.swift [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
README.md [doc] Core is now C++ (#35676) 2024-01-26 11:21:26 -08:00
Rakefile No public description 2024-03-07 10:26:42 -08:00
SECURITY.md Add security policy doc 2021-01-22 10:38:04 -08:00
TROUBLESHOOTING.md [grpc][Gpr_To_Absl_Logging] Supporting verbosity flag (#36798) 2024-06-06 19:08:32 -07:00
WORKSPACE [Build] Migrate Android NDK, android rules and platforms (#36116) 2024-03-19 11:46:15 -07:00
_metadata.py [Release] Bump version to 1.65.0-dev (on master branch) (#36544) 2024-05-06 14:41:36 -07:00
black.toml [Python O11Y] Update deps file when building new abseil-cpp (#35681) 2024-01-26 14:52:13 -08:00
build_autogenerated.yaml [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
build_config.rb [Release] Bump core version 202405022240 (#36515) 2024-05-02 17:09:03 -07:00
build_handwritten.yaml [Release] Bump version to 1.65.0-dev (on master branch) (#36544) 2024-05-06 14:41:36 -07:00
composer.json update required minimal php version to 7.0 2020-11-19 23:52:44 +03:00
config.m4 [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
config.w32 [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
gRPC-C++.podspec [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
gRPC-Core.podspec [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
gRPC-ProtoRPC.podspec [Release] Bump version to 1.65.0-dev (on master branch) (#36544) 2024-05-06 14:41:36 -07:00
gRPC-RxLibrary.podspec [Release] Bump version to 1.65.0-dev (on master branch) (#36544) 2024-05-06 14:41:36 -07:00
gRPC.podspec [Release] Bump version to 1.65.0-dev (on master branch) (#36544) 2024-05-06 14:41:36 -07:00
grpc.bzl Internal change 2023-12-13 20:06:30 -08:00
grpc.def [grpc][Gpr_To_Absl_Logging] Deleting multiple instances of gpr_set_log_function (#36833) 2024-06-07 09:14:44 -07:00
grpc.gemspec [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
grpc.gyp [reorg] move ext/gcp/metadata_query.* -> util/gcp_metadata_query.* (#36789) 2024-05-31 22:40:20 -07:00
package.xml [logging] Centralize configuration for trace flags (#36576) 2024-06-07 10:47:38 -07:00
requirements.bazel.txt [Python CSM] Changes to enable Python CSM interop tests (#36790) 2024-06-03 16:45:28 -07:00
requirements.txt [Python grpcio_tools] Update version requirement of protobuf in grpcio_tools (#36230) 2024-04-11 15:39:29 -07:00
setup.cfg [Build] Shortened python_build to pyb (#34913) 2023-11-09 22:31:40 -08:00
setup.py [reorg] move telemetry code to src/core/telemetry (#36644) 2024-05-23 15:54:07 -07:00

README.md

gRPC An RPC library and framework

gRPC is a modern, open source, high-performance remote procedure call (RPC) framework that can run anywhere. gRPC enables client and server applications to communicate transparently, and simplifies the building of connected systems.

Homepage: grpc.io
Mailing List: grpc-io@googlegroups.com

Join the chat at https://gitter.im/grpc/grpc

To start using gRPC

To maximize usability, gRPC supports the standard method for adding dependencies to a user's chosen language (if there is one). In most languages, the gRPC runtime comes as a package available in a user's language package manager.

For instructions on how to use the language-specific gRPC runtime for a project, please refer to these documents

  • C++: follow the instructions under the src/cpp directory
  • C#/.NET: NuGet packages Grpc.Net.Client, Grpc.AspNetCore.Server
  • Dart: pub package grpc
  • Go: go get google.golang.org/grpc
  • Java: Use JARs from Maven Central Repository
  • Kotlin: Use JARs from Maven Central Repository
  • Node: npm install @grpc/grpc-js
  • Objective-C: Add gRPC-ProtoRPC dependency to podspec
  • PHP: pecl install grpc
  • Python: pip install grpcio
  • Ruby: gem install grpc
  • WebJS: follow the grpc-web instructions

Per-language quickstart guides and tutorials can be found in the documentation section on the grpc.io website. Code examples are available in the examples directory.

Precompiled bleeding-edge package builds of gRPC master branch's HEAD are uploaded daily to packages.grpc.io.

To start developing gRPC

Contributions are welcome!

Please read How to contribute which will guide you through the entire workflow of how to build the source code, how to run the tests, and how to contribute changes to the gRPC codebase. The "How to contribute" document also contains info on how the contribution process works and contains best practices for creating contributions.

Troubleshooting

Sometimes things go wrong. Please check out the Troubleshooting guide if you are experiencing issues with gRPC.

Performance

See the Performance dashboard for performance numbers of master branch daily builds.

Concepts

See gRPC Concepts

About This Repository

This repository contains source code for gRPC libraries implemented in multiple languages written on top of a shared C++ core library src/core.

Libraries in different languages may be in various states of development. We are seeking contributions for all of these libraries:

Language Source
Shared C++ [core library] src/core
C++ src/cpp
Ruby src/ruby
Python src/python
PHP src/php
C# (core library based) src/csharp
Objective-C src/objective-c
Language Source repo
Java grpc-java
Kotlin grpc-kotlin
Go grpc-go
NodeJS grpc-node
WebJS grpc-web
Dart grpc-dart
.NET (pure C# impl.) grpc-dotnet
Swift grpc-swift