エクステンドの可観測性入門

Last updated on October 23, 2024

Overview

Grafana Cloud is a robust and comprehensive monitoring and observability platform designed to empower organizations with real-time visualization and analysis of their metrics and logs. It offers a fully managed and scalable solution, enabling effective monitoring across diverse aspects of infrastructure and applications. With its customizable dashboards, intuitive interface, and extensive plugin ecosystem, Grafana Cloud facilitates seamless data exploration, issue troubleshooting, and informed decision-making. By providing a unified platform for visualizing and comprehending system health and performance, Grafana Cloud proves to be an ideal choice for organizations seeking advanced observability capabilities. For more information about Grafana cloud offerings, please visit https://grafana.com/.

For these reasons, AccelByte has strategically partnered with Grafana Cloud as the preferred back-end solution for its observability requirements. Moreover, Grafana Cloud's support for Label Based Access Control (LBAC) ensures secure access control for metrics and logs, with tracing support to be introduced in 2024. This LBAC functionality enables the AccelByte team to provide telemetry access to clients while maintaining strict segregation at the client level, ensuring data privacy and confidentiality.

Grafana Cloud availability

Grafana Cloud is part of the full Extend package, available in both AGS tiers: Private Cloud and Shared Cloud.

AGS Shared Cloud

For Shared Cloud users on a free trial, you can access Grafana Cloud and all other Extend features once you unlock the tier.

Access Grafana Cloud dashboards

You can get the access link for your Grafana Cloud dashboards from the details page of your Extend apps. Follow these steps:

1. Go to the details page of the Extend app with the Grafana Cloud dashboard you want to view.

2. At the bottom of the App Detail table, click on Open Grafana Cloud. A new browser tab is opened for Grafana Cloud.

3. Log in using your AGS Admin Portal account.

To learn how to navigate Grafana Cloud dashboards, refer to the guide for each app type:

• Extend Override
• Extend Service Extension
• Extend Event Handler

Observability in the context of the Extend App

Our goal is to provide you, as a developer of your Extend app hosted by AccelByte, with comprehensive observability capabilities for your application. This observability encompasses infrastructure health metrics and service health metrics tailored to your specific service deployment. Our commitment is to continually enhance the observability coverage and expand it to include logs and traces in the future. By doing so, we aim to empower you with deeper insights into the performance and behavior of your app, enabling effective monitoring and troubleshooting.

You, as a game developer or studio, will have the ability to query logs and metrics for your Extend app to help troubleshoot issues.

Infrastructure health metrics

We provide the following infrastructure metrics in your Grafana stack:

• App instances count & status
• CPU Utilization
  • Limit
  • Request
• Memory consumption
  • Limit
  • Request
• Storage
  • Disk Space
  • IOPS
• Network
  • Bandwidth
  • Network usage

Service health metrics

The following service metrics can be accessed in the Grafana stack:

• Request count
  • gRPC
    • Total request
    • Total request per gRPC status code
    • Request latency
    • Error rates
  • HTTP
    • Total request
    • Total 2xx request
    • Total 4xx request
    • Total 5xx request
    • Request latency
• Incoming kafka events (if applicable)
• Application creation duration
• Deployment creation duration

Metrics and logs query capabilities

As a developer of your Extend app, you have the capability to see your application logs and metrics in Grafana Cloud. We provide this capability by enabling LBAC data sourcing from our central stack to be queried and retrieved from your dedicated stack. To query metrics and logs from your Grafana Cloud stack, you can follow these steps:

explained in the section above

2. On the sidebar, go to the Explore section.

   

3. Grafana Cloud provides you a query editor that allows you to specify the exact metrics or log data you want to retrieve. Data sources for your application usually follow the pattern log-<your studio name> or metrics-<your studio name>. You can pick the data source for logs/metrics by accessing the dropdown on the top.

   

4. To get your application data, apply the label filters. Choose the namespace label and select extend-accelbyte-custom-service as the value. You can also narrow down the result by utilizing the time filters.

5. Once your queries are defined, you can execute the query using the run query button in the top-right.

   

6. Grafana Cloud will return logs and metrics based on the defined queries in JSON format.

Send logs to Grafana Cloud

You can send logs from your Extend app to Grafana Cloud by writing the logs to standard output.

Go

// Import required package
import (
  "github.com/sirupsen/logrus"
)

// Write log
logrus.Infof("your log message")

C#

Use ILogger<YourClassName> object in your gRPC service implementation class to write logs.

// Import namespace
using Microsoft.Extensions.Logging;

// Declare private logger object
private readonly ILogger<YourClassName> _Logger;

// Get logger object in constructor
public YourClassName(
  ...
  ILogger<YourClassName> logger,
  ...
)
{
  ...
  _Logger = logger;
  ...
}

// Use it within the method
_Logger.LogInformation("your log message");

Java

// Import Slf4j package
import lombok.extern.slf4j.Slf4j;

// Add Slf4J annotation to your service class
@Slf4j

// Use it within the method
log.info("your log message");

備考

For more information about Slf4j annotation, refer to the Project Lombok documentation.

Python

# Import logger
from logging import Logger

# init logger in service class
def __init__(
  ..., logger: Optional[Logger], ...
) -> None:
  ...
  self.logger = logger
  ...

# Use it within the function
self.logger.info("your log message")

Visualization

As an Extend app developer, you can visualize the health of an Extend service by utilizing the available dashboards. After your Extend app is provisioned, you can expect the following canned dashboards to be created:

Dashboards

Dashboards will be accessible in the following path: https://<your-grafana-dedicated-stack>.grafana.net/dashboards. As an example, your stack URL might be like this: https://accelbyte12345.grafana.net/dashboards

Custom metrics

You will have the ability to annotate and publish your service-specific metrics to help gain further insights into your app's performance. These metrics will be the metrics that you choose to expose and the metrics that are supplied by the Extend platform. Support and documentation for these metrics will be added soon.