# Project Access

The microservices governance platform is designed to help you better observe the health status of your services, covering different dimensions such as distributed full-link tracking, error analysis, alarm management and custom dashboard, and simplify the operation and maintenance process to make it easier and more efficient.

The platform manages associated application data from a project perspective, so you need to focus on how to create or access microservice governance projects first to use the monitoring and analysis functions provided by the platform. It is necessary as the data generated by the application, such as metrics, traces, and logs, must be explicitly authorized to be properly captured and stored by the platform. The process is as follows:

Create a project, and data belonging to the same project will be managed together.
Generate an authorization token to identify the attribution of the reported data.
The application integrates the collection SDK to report monitoring data.

Go to Org Center > Projects > Add Project. There are several project types available, such as DevOps project, monitoring project, code hosting project, etc. DevOps project and monitoring project are supported for integration by the microservice governance platform, with different access methods, which will be introduced in detail in the following.

# How to Select a Project

# DevOps Project

DevOps projects provide functions such as project management, code hosting, and CI/CD. For DevOps projects, the platform accesses the microservice governance platform by providing a monitor addon, which will automatically complete the injection of authorization token and collection SDK.

You can choose the DevOps project for the following situations:

In addition to the needs of the microservice governance platform, you also need the features such as project management, code hosting, and CI/CD provided by the DevOps project.
Your application language is Java or Nodejs (currently the monitor addon only supports SDK injections for programs in these two languages).

# Monitoring Project

The monitoring project focuses on features such as service monitoring, tracing analysis, custom dashboard, and alarm. Compared to DevOps projects, monitoring projects offer a more common, flexible, and configurable way for access, while serving as the server for protocols such as OpenTelemetry and OpenTracing, and integrating with numerous collection SDKs that support the protocol.

You can choose the monitoring project for the following situations:

You only need the monitoring features provided by the microservices governance platform.
Your project is not hosted by Erda and cannot be accessed as the DevOps project described above.
Your application language is not supported by the monitor addon.
You already have a collection SDK that is compatible with the OpenTelemetry or OpenTracing protocol.

# DevOps Project Access

Before you start, please make sure you have created a DevOps project, dice.yml, and pipeline for deployment. For details, see Deploy via Pipeline.

# Add Monitor Addon

Tips

This step is optional. Applications deployed through the pipeline will have the monitor addon added automatically.

Edit dice.yml to add the monitor addon.

You can add by the graphic editing mode:

Or edit dice.yml in text mode:

  addons:
    monitor:
      plan: monitor:basic
      options:
        version: '3.6'

# Run Pipeline to Deploy Application

Go to App > Pipeline, add a new pipeline and run it.

During the pipeline deployment, it will perform specific logic specified by the monitor addon:
- Register a project with the microservice governance platform.
- Apply for an authorization token from the microservices governance platform.
- Add the collection SDK to the packaged image.
- Inject the authorization token into the environment variable of the deployed application.
After the pipeline is successfully executed, you can go to the homepage of the microservice governance platform to view the project just deployed.

# Monitoring Project Access

# Add Monitoring Project

Please follow the steps below to create a project:

Go to Org Center > Projects.

Click Add Project.
Select the Monitoring Project, and enter the project name, identifier and other information according to the prompts.

After completing the project creation, go to the homepage of the microservice governance platform to view the project just created, and click to enter the project space.

# Create Access Token

Go to Microservice Governance Platform > Environment Settings > Access Configuration.

Click Create Token in the upper right corner, and the page will show the information of the created token.

# Integrate SDK

For external project access, considering the multi-language and openness issues, currently the platform integrates with the protocols of the open-source community and supports all collection SDKs compatible with OpenTelemetry and OpenTracing to report data.

On the access configuration page, the platform provides instructions for Jaeger client access in multiple languages by default. Here takes the Java language as an example.

# Get Endpoint and Authentication Information

Endpoint: The API address for data receiving.
Environment ID: Different projects and environments (development, testing, staging, production) have different environment IDs to distinguish data attribution.
Token: Used for authentication.

# Reference SDK and Configure Authentication Information

You can configure authentication information in the header of the HTTP/HTTPS protocol or the tag field of the Jaeger protocol. The fields and descriptions are as follows.

erda.env.id: Environment ID of microservice project.
erda.env.token: Authentication token of microservice environment, created and obtained on this page.

The following is an example of data reported by Jaeger SpringCloud Starter:

Import opentracing-spring-jaeger-cloud-starter dependency.

<dependency>
    <groupId>io.opentracing.contrib</groupId>
    <artifactId>opentracing-spring-jaeger-cloud-starter</artifactId>
    <version>3.3.1</version>
</dependency>

Configure Jaeger in application.yml.

opentracing:
  jaeger:
    service-name: <your_service_name>
    http-sender:
      url: https://collector.daily.terminus.io/api/jaeger/traces
    log-spans: true
    tags:
      erda.env.id: <your_env_id>
      erda.env.token: <your_token>

← Use Nacos Cloud Service Overview →