Parameter | Required | Description |
--app-key | Yes | The authentication information of Server-side Monitoring. Although the App Key credential is independent of the integrated service type and data collection method, the App Key differs across workspaces. To obtain App Key, see How to obtain the AppKey for Server-side Monitoring authentication?. |
--region | Yes | ID of the region for service integration, such as cn-beijing. For information about regions currently supported by Server-side Monitoring, see Server-launching region. |
--service-name | Yes | The service name, such as claude-code-apmplus. The displayed service name in Server-side Monitoring. You can customize the service name based on your needs. |
--version | No | Specifies the installation version. The default value is latest. Both 0.1.0 and v0.1.0 formats are supported. |
--package-url | No | Overrides the download URL of the plugin package, typically used only for canary releases or troubleshooting. |
--tos-base-url | No | Overrides the root TOS URL. The official release URL is used by default. |
--no-launchctl | No | Skips writing launchctl environment variables on macOS and updates only the Claude settings. |
Issue description | Recommended solution |
Prompt: --region, --app-key and --service-name are required | Required parameters in the installation command are missing. Add --region, --app-key, and --service-name, and then try again. |
Prompt: --endpoint is no longer supported | Do not manually specify the endpoint. Instead, specify--region and --app-key, which can be automatically concatenated by the installation script. |
Prompt: --region should be a region id | Enter the Region ID for --region only, such as cn-beijing. You do not need to enter a complete URL or the apmplus- prefix. |
Prompt: --app-key should be the appKey only | Enter the appKey for --app-key only. You do not need to enter the complete URL or endpoint. |
Prompt: claude command is required | Claude Code is not installed on the local device, or Claude is not in the PATH of the current shell. |
Failed to download the plugin package | Check whether the TOS domain is accessible over the network, or use --package-url to point to an accessible plugin package URL. |
No Trace in APMPlus | Confirm that Claude Code has been restarted, and check the region, appKey, service name, network egress, and the APMPlus query time range. |
The environment does not take effect after a macOS restart | Execute the installation command again, or omit the --no-launchctl parameter to enable the script to write the launchctl environment synchronously. |