Observability Design and Implementation of EG

[Xunzhuo]

Description:

This issue tracks the Observability designs and implementations of EG.

EG Observability Design should be two main parts and such subtasks:

• The Control Plane (CP): Design and Implement the CP Observability of EG (https://github.com/envoyproxy/gateway/issues/700).

  • [ ] Metrics generated by Envoy Gateway
  • [ ] Logging generated by Envoy Gateway
  • [ ] Tracing generated by Envoy Gateway

• The Data Plane (DP): Design and Implement the DP Observability of EG (https://github.com/envoyproxy/gateway/issues/699).

  • [x] Access Logging generated by EnvoyProxy
  • [x] Tracing generated by EnvoyProxy
  • [x] Metrics generated by EnvoyProxy

Welcome to comment your ideas related to Observability here.

[danehans]

@Xunzhuo unless you're actively working on this issue, can you unassign yourself and add the help-wanted label?

[Xunzhuo]

@danehans I will still assign myself to this issue, this issue records the process of implementing EG observability, I will schedule to work on this in the next releases.

But I free some sub tasks of this epic, hope that someone can work on them, or I can spare some time on them.

[arkodg]

@zirain since you're interested as well as fairly knowledgable in this area, assigning this issue to you as well, hoping you and @Xunzhuo can tackle this together in the next release 🚀

[zirain]

xref: https://github.com/istio/istio/pull/44094 case about grpc stats

[jcchavezs]

We should also include observability for filters here even if the work is done upstream.

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had activity in the last 30 days.

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had activity in the last 30 days.

[zirain]

@shawnh2 will work on control plane part.

[kevintatou]

how is the support for openetelemtry traces, logs, metrics? I can see it is in design phase on envoyproxies page. Is there anything more being done?

[zirain]

how is the support for openetelemtry traces, logs, metrics? I can see it is in design phase on envoyproxies page. Is there anything more being done?

it's completed, you can try it.

[kevintatou]

how is the support for openetelemtry traces, logs, metrics? I can see it is in design phase on envoyproxies page. Is there anything more being done?

it's completed, you can try it.

Is there any example on how to do it in otel with my own collector? I cant seem to find it 🤔

[zirain]

I cannot recall if there's a user face doc, but you check the e2e test https://github.com/envoyproxy/gateway/tree/main/test/e2e

[shawnh2]

The Metrics of EG CP will be discussed and resolved in #2092

[kevintatou]

@shawnh2 so metrics is not implemented yet? Do you know if tracing is?

[shawnh2]

@shawnh2 so metrics is not implemented yet? Do you know if tracing is?

hi @kevintatou, the metrics/tracing/logging for envoy gateway control plane is not implemented yet. But the data plane does (all of them), you can browse the doc to find more.

[Xunzhuo]

Let us close this, and track cp metrics progress in https://github.com/envoyproxy/gateway/issues/2092.

[pkit]

@zirain any plans on doing otel over http? writing a grpc service just to get the access log looks like overkill to me...

[zirain]

@zirain any plans on doing otel over http? writing a grpc service just to get the access log looks like overkill to me...

does grpc has better perfmance?

[pkit]

It does. Usually.