Deploys API

Track deployments to correlate releases with performance changes and error rates.

Endpoint

POST /ingest/deploys

Headers

Header	Required	Description
Authorization	Yes	Bearer <api_key>
Content-Type	Yes	application/json

Request Body

{
  "git_sha": "abc123def456",
  "version": "v1.2.3",
  "deployer": "github-actions",
  "env": "production",
  "description": "Fix payment processing bug",
  "timestamp": "2024-01-15T14:30:00Z"
}

Fields

Field	Type	Required	Description
git_sha	string	Yes	Git commit SHA
version	string	No	Version tag or number
env	string	No	Target environment
deployer	string	No	Who/what triggered the deploy
description	string	No	Deploy description
timestamp	string	No	ISO 8601 timestamp (defaults to now)

Response

Returns 202 Accepted on success with no response body.

Example

curl -X POST http://localhost:3000/ingest/deploys \
  -H "Authorization: Bearer proj_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "git_sha": "abc123def456789",
    "version": "v1.2.3",
    "deployer": "github-actions",
    "env": "production"
  }'

CI/CD Integration

GitHub Actions

.github/workflows/deploy.yml

- name: Notify MiniAPM
  run: |
    curl -X POST ${{ secrets.MINIAPM_URL }}/ingest/deploys \
      -H "Authorization: Bearer ${{ secrets.MINIAPM_API_KEY }}" \
      -H "Content-Type: application/json" \
      -d "{
        \"git_sha\": \"${{ github.sha }}\",
        \"version\": \"${{ github.ref_name }}\",
        \"deployer\": \"github-actions\",
        \"env\": \"production\"
      }"

GitLab CI

.gitlab-ci.yml

notify_miniapm:
  stage: deploy
  script:
    - |
      curl -X POST $MINIAPM_URL/ingest/deploys \
        -H "Authorization: Bearer $MINIAPM_API_KEY" \
        -H "Content-Type: application/json" \
        -d "{
          \"git_sha\": \"$CI_COMMIT_SHA\",
          \"version\": \"$CI_COMMIT_TAG\",
          \"deployer\": \"gitlab-ci\",
          \"env\": \"$CI_ENVIRONMENT_NAME\"
        }"

Capistrano

config/deploy.rb

after :finishing, :notify_miniapm do
  on roles(:app) do
    execute :curl, "-X POST #{ENV['MINIAPM_URL']}/ingest/deploys",
      "-H 'Authorization: Bearer #{ENV['MINIAPM_API_KEY']}'",
      "-H 'Content-Type: application/json'",
      "-d '{\"git_sha\": \"#{fetch(:current_revision)}\", \"deployer\": \"capistrano\"}'"
  end
end

Heroku

# In your release phase or post-deploy hook
curl -X POST $MINIAPM_URL/ingest/deploys \
  -H "Authorization: Bearer $MINIAPM_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{
    \"git_sha\": \"$HEROKU_SLUG_COMMIT\",
    \"version\": \"$HEROKU_RELEASE_VERSION\",
    \"deployer\": \"heroku\"
  }"

Kamal

config/deploy.yml

hooks:
  post-deploy:
    - |
      curl -X POST $MINIAPM_URL/ingest/deploys \
        -H "Authorization: Bearer $MINIAPM_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{"git_sha": "<%= `git rev-parse HEAD`.strip %>", "version": "<%= `git describe --tags --always`.strip %>", "deployer": "kamal"}'

Ruby Integration

Using the miniapm gem:

# In your deploy script or initializer
MiniAPM.record_deploy(
  version: ENV['APP_VERSION'],
  git_sha: ENV['GIT_SHA'],
  deployer: 'my-deploy-script'
)

Dashboard Features

Once deploys are recorded, you’ll see:

• Deploy markers on performance graphs
• Deploy timeline showing all deployments
• Correlation between deploys and performance changes

Best Practices

1. Always include git_sha - It’s the only required field and makes it easy to identify exact code versions
2. Use meaningful version tags - Semver or date-based versions work well
3. Record deploys after success - Only notify after deploy completes
4. Include env - Track staging vs production separately