Migas客户端

用于与migas服务器通信的Python包。

关于

migas (mee-gahs) 是一个Python客户端，用于方便与 migas 服务器 通信。

用法

要开始与migas服务器通信，客户端必须首先进行设置。

import migas; migas.setup()

默认情况下，migas-py 将与官方托管 migas 服务器通信。但是，它可以轻松配置以与任何托管 migas 服务器通信。

import migas; migas.setup(endpoint='your-endpoint')

setup() 将填充 内部配置，这是在进程级别完成的。

API

migas 包含以下功能，用于与遥测服务器通信

migas.add_breadcrumb() {#addbreadcrumb}

向服务器发送带有使用信息的面包屑。

必需

• project - 应用程序名称
• project_version - 应用程序版本

可选

• language（自动检测）
• language_version（自动检测）
• 进程
  • 状态
  • 状态描述
  • 错误类型
  • 错误描述
• 上下文
  • user_id（自动生成）
  • 会话ID
  • 用户类型
  • 平台（自动检测）
  • 容器（自动检测）
  • is_ci（自动检测）

>>> add_breadcrumb('nipreps/migas-py', '0.0.1', status='R', status_desc='Finished long step')
{'success': True}

migas.check_project() {#checkproject}

检查项目版本与后续开发的一致性。

必需

• 项目
• 项目版本

>>> check_project('nipreps/migas-py', '0.0.1')
{'success': True, 'flagged': False, 'latest': '0.4.0', 'message': ''}

migas.get_usage() {#getusage}

检查自起始日期以来一个项目接收到的使用次数，并可选地指定一个结束日期。如果没有指定结束日期，则使用当前时间。

>>> get_usage('nipreps/migas-py', '2022-07-01')
{'hits': 7, 'message': '', 'unique': False, 'success': True}

migas.track_exit() {#trackexit}

注册一个退出函数，在Python解释器终止时发送一个最后的ping。当监控可能预先发生错误的进程时很有用。输入与add_breadcrumb()相同

用户控制

migas可以通过以下环境变量进行控制

配置

内部配置存储以下遥测信息

• 语言和语言版本
• 操作系统
• 在容器内运行
• 从持续集成运行