将可观测链路 OpenTelemetry 版控制台页面嵌入自建Web应用

如需在自建Web应用中免登录查看可观测链路 OpenTelemetry 版控制台的页面,您可将可观测链路 OpenTelemetry 版控制台嵌入自建Web应用,以此避免系统间的来回切换。

教程概述

预期结果

参照本教程的方法进行实际操作后将实现以下效果:

  • 可登录您的自有系统并浏览嵌入的应用列表、应用详情、调用查询等页面。

  • 可隐藏可观测链路 OpenTelemetry 版页面的顶部导航栏和左侧导航栏。

  • 可通过访问控制RAM系统控制操作权限,例如将完整权限改为只读权限等。

访问流程

使用本教程所述方法访问可观测链路 OpenTelemetry 版页面的流程如图所示。

image

步骤一:创建RAM用户并添加权限

首先使用阿里云账号创建RAM用户并为其添加调用STS服务扮演RAM角色的权限。

  1. 使用阿里云账号(主账号)或RAM管理员登录RAM控制台

  2. 在左侧导航栏,选择身份管理 > 用户

  3. 用户页面,单击创建用户

    image

  4. 创建用户页面的用户账号信息区域框中,输入登录名称显示名称。在访问方式区域框中,勾选使用永久 AccessKey 访问,并单击确定

    重要

    RAM会自动为RAM用户创建AccessKey(API访问密钥)。出于安全考虑,RAM控制台只提供一次查看或下载AccessKeySecret的机会,即创建AccessKey时,请务必将AccessKeySecret记录到安全的地方。

  5. 用户页面,单击目标RAM用户操作列的添加权限

    image

    您也可以选中多个RAM用户,单击用户列表下方的添加权限,为RAM用户批量授权。

  6. 新增授权面板,为RAM用户添加权限。

    1. 选择资源范围。

    2. 选择授权主体。

      授权主体即需要添加权限的RAM用户。系统会自动选择当前的RAM用户。

    3. 选择权限策略AliyunSTSAssumeRoleAccess

    4. 单击确认新增授权

  7. 单击关闭

步骤二:创建RAM角色并添加权限

接下来创建RAM角色并为其添加访问可观测链路 OpenTelemetry 版控制台的权限。上一步创建的RAM用户将会扮演该RAM角色访问可观测链路 OpenTelemetry 版控制台。

  1. 创建可信实体为阿里云账号的RAM角色

  2. 为角色添加AliyunTracingAnalysisFullAccessAliyunTracingAnalysisReadOnlyAccess权限。具体操作,请参见RAM角色授权

    • 如需添加可观测链路 OpenTelemetry 版的完整权限,则添加AliyunTracingAnalysisFullAccess

    • 如需添加可观测链路 OpenTelemetry 版的只读权限,则添加AliyunTracingAnalysisReadOnlyAccess

步骤三:获取临时AccessKeyToken

登录自建Web后,在Web服务端调用STS AssumeRole接口获取临时AccessKeyToken,即临时身份。请选择一种方式调用该接口:

请注意,在示例代码中,您首先需要将以下参数替换为真实的值。

String akId = "<accessKeyId>";
String ak = "<accessKeySecret>";
String roleArn = "<roleArn>";

其中,<accessKeyId><accessKeySecret>是步骤一中创建的用户的AccessKeyIdAccessKeySecret。获取操作,请参见创建AccessKey

Example AccessKey

<roleArn>是准备工作中创建的RAM角色的标识ARN,可在RAM控制台的角色基本信息页面获取。

Example ARN

步骤四:获取登录Token

在通过STS AssumeRole接口获取临时AccessKeyToken后,调用登录服务接口获取登录Token。

重要

STS返回的安全Token中可能包含特殊字符,请对特殊字符进行URL编码后再输入。

请求样例:

http://signin4service.aliyun.com/federation?Action=GetSigninToken
    &AccessKeyId=<STS返回的临时AccessKeyId>
    &AccessKeySecret=<STS返回的临时AccessKeySecret>
    &SecurityToken=<STS返回的安全Token>
    &TicketType=mini

步骤五:生成免登录链接

利用获取到的登录Token与待嵌入的可观测链路 OpenTelemetry 版控制台页面链接生成免登录访问链接,以最终实现在自建Web中免登录访问可观测链路 OpenTelemetry 版控制台页面的目的。

说明

由于Token有效期为3小时,建议在自建Web应用中将链接设置为每次请求时生成新登录Token,通过302请求返回进行跳转。

  1. 可观测链路 OpenTelemetry 版控制台获取待嵌入的控制台页面链接。例如杭州地域的应用列表页面的链接为:

    https://trace4service.console.aliyun.com/#/overview/cn-hangzhou
    说明

    hideTopbar设为true表示隐藏顶部导航栏,将hideSidebar设为true表示隐藏左侧导航栏。

  2. 利用步骤二中获取到的登录Token可观测链路 OpenTelemetry 版控制台页面链接生成免登录访问链接。 请求样例:

        http://signin.aliyun.com/federation?Action=Login
        &LoginUrl=<登录失效跳转的地址,一般配置为自建Web配置302跳转的URL>
        &SigninToken=<获取到的登录Token>
        &Destination=<可观测链路 OpenTelemetry 版控制台页面链接>

执行结果

登录自建Web应用后,可见嵌入的可观测链路 OpenTelemetry 版控制台页面效果如下图所示:

70

操作样例

本教程的示例代码基于Java SDK,以嵌入可观测链路 OpenTelemetry 版控制台的应用列表为例。

获取示例代码