Stay organized with collections
Save and categorize content based on your preferences.
Observability and debugging with Service Directory
Cloud Service Mesh's integration with Service Directory introduces new
complexities in debugging. Within your business, service consumers and
service producers might belong to different teams or organizations. To help you
debug such issues, Cloud Service Mesh integrates with Cloud Logging and
Cloud Monitoring.
For example:
You have a checkout service that uses Cloud Service Mesh for
application networking.
There's a payment service in Service Directory that a
different team (the service producer) owns and maintains.
You want to call on the payment service from the checkout service so
you create a new backend service in Cloud Service Mesh. This backend service
attaches to the payment service using Service Directory for
service discovery.
In this model, the service producer might want to delete or modify the paymentservice that is hosted in Service Directory. Because they own
the payment service, they are permitted to make such changes. But if the
payment service is deleted, service discovery is broken.
Logging
When Cloud Service Mesh resolves a backend service that is attached to a
Service Directory service, it gets a list of endpoints from
Service Directory. If the service has been deleted from
Service Directory, Cloud Service Mesh doesn't get any endpoints.
In such a case, a log entry is added to Logging. The log entry
includes the following information:
The backend service name
The Service Directory name
A message: Service Directory returned 0 endpoints for this service.
This information helps you debug issues. You can also set up alerts to be
proactively notified.
Monitoring
Similar to the logging case, Cloud Service Mesh integrates with
Monitoring to generate metrics. Cloud Service Mesh adds the
following metrics to Monitoring for each backend service:
The backend service name
The number of endpoints associated with this backend service that are
shared with Cloud Service Mesh's clients
Cloud Service Mesh clients are not able to send traffic to backend services that
don't have endpoints.
Google Cloud console
If a Service Directory service is deleted and an attachment to
that service exists in the Cloud Service Mesh backend service, the
Google Cloud console displays a warning: The attached
Service Directory service could not be found.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[],[],null,["# Observability and debugging with Service Directory\n==================================================\n\n|\n| **Preview**\n|\n|\n| This product or feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA products and features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n| **Deprecated:** Cloud Service Mesh's integration with Service Directory is going to be deprecated. Creating new service binding resources will be disabled.\n\nCloud Service Mesh's integration with Service Directory introduces new\ncomplexities in debugging. Within your business, service consumers and\nservice producers might belong to different teams or organizations. To help you\ndebug such issues, Cloud Service Mesh integrates with Cloud Logging and\nCloud Monitoring.\n\nFor example:\n\n- You have a `checkout` service that uses Cloud Service Mesh for application networking.\n- There's a `payment` service in Service Directory that a different team (the *service producer*) owns and maintains.\n- You want to call on the `payment` service from the `checkout` service so you create a new backend service in Cloud Service Mesh. This backend service attaches to the `payment` service using Service Directory for service discovery.\n\nIn this model, the service producer might want to delete or modify the `payment`service that is hosted in Service Directory. Because they own\nthe `payment` service, they are permitted to make such changes. But if the\n`payment` service is deleted, service discovery is broken.\n| **Note:** This guide only supports Cloud Service Mesh with Google Cloud APIs and does not support Istio APIs. For more information see, [Cloud Service Mesh overview](/service-mesh/docs/overview).\n\nLogging\n-------\n\nWhen Cloud Service Mesh resolves a backend service that is attached to a\nService Directory service, it gets a list of endpoints from\nService Directory. If the service has been deleted from\nService Directory, Cloud Service Mesh doesn't get any endpoints.\nIn such a case, a log entry is added to Logging. The log entry\nincludes the following information:\n\n- The backend service name\n- The Service Directory name\n- A message: `Service Directory returned 0 endpoints for this service.`\n\nThis information helps you debug issues. You can also set up alerts to be\nproactively notified.\n\nMonitoring\n----------\n\nSimilar to the logging case, Cloud Service Mesh integrates with\nMonitoring to generate metrics. Cloud Service Mesh adds the\nfollowing metrics to Monitoring for each backend service:\n\n- The backend service name\n- The number of endpoints associated with this backend service that are shared with Cloud Service Mesh's clients\n\nCloud Service Mesh clients are not able to send traffic to backend services that\ndon't have endpoints.\n\nGoogle Cloud console\n--------------------\n\nIf a Service Directory service is deleted and an attachment to\nthat service exists in the Cloud Service Mesh backend service, the\nGoogle Cloud console displays a warning: `The attached\nService Directory service could not be found.`\n\nWhat's next\n-----------\n\n- Learn about [integrating Cloud Service Mesh with Service Directory](/service-mesh/docs/service-routing/service-directory-integration).\n- Learn how to [set up the integration](/service-mesh/docs/service-routing/service-directory-integration-setup).\n- Learn about [Service Directory observability](/service-directory/docs/monitoring)."]]