webtask.json

{
  "title": "Auth0 Logs to Logstash",
  "name": "auth0-logs-to-logstash",
  "version": "2.1.0",
  "preVersion": "2.0.7",
  "author": "auth0",
  "category": "log_export",
  "description": "This extension will continuously export your Auth0 logs to Logstash",
  "type": "cron",
  "initialUrlPath": "/login",
  "repository": "https://github.com/auth0-extensions/auth0-logs-to-logstash",
  "docsUrl": "https://auth0.com/docs/extensions/logstash",
  "logoUrl": "https://cdn.auth0.com/extensions/auth0-logs-to-logstash/assets/logo.png",
  "keywords": [
    "auth0",
    "extension"
  ],
  "schedule": "0 */5 * * * *",
  "auth0": {
    "createClient": true,
    "onUninstallPath": "/.extensions/on-uninstall",
    "scopes": "read:logs delete:clients"
  },
  "secrets": {
    "BATCH_SIZE": {
      "description": "The amount of logs to batch before sending to Logstash. A single cron execution will send multiple batches.",
      "default": 100
    },
    "LOGSTASH_URL": {
      "description": "Logstash URL (from logstash-input-http)",
      "example": "https://listener.logz.io:8071",
      "required": true
    },
    "LOGSTASH_INDEX": {
      "description": "Logstash Index (as defined in Logstash setup)",
      "required": true
    },
    "LOGSTASH_TOKEN": {
      "description": "Logstash Token (optional)",
      "type": "password"
    },
    "LOGSTASH_USER": {
      "description": "Logstash User (optional)"
    },
    "LOGSTASH_PASSWORD": {
      "description": "Logstash Password (optional)",
      "type": "password"
    },
    "START_FROM": {
      "description": "Checkpoint ID of log to start from."
    },
    "SLACK_INCOMING_WEBHOOK_URL": {
      "description": "Slack Incoming Webhook URL used to report statistics and possible failures"
    },
    "SLACK_SEND_SUCCESS": {
      "description": "This setting will enable verbose notifications to Slack which are useful for troubleshooting",
      "type": "select",
      "allowMultiple": false,
      "default": "false",
      "options": [
        {
          "value": "false",
          "text": "No"
        },
        {
          "value": "true",
          "text": "Yes"
        }
      ]
    },
    "LOG_LEVEL": {
      "description": "This allows you to specify the log level of events that need to be sent",
      "type": "select",
      "allowMultiple": true,
      "options": [
        {
          "value": "-",
          "text": ""
        },
        {
          "value": "0",
          "text": "Debug"
        },
        {
          "value": "1",
          "text": "Info"
        },
        {
          "value": "2",
          "text": "Warning"
        },
        {
          "value": "3",
          "text": "Error"
        },
        {
          "value": "4",
          "text": "Critical"
        }
      ]
    },
    "LOG_TYPES": {
      "description": "If you only want to send events with a specific type (eg: failed logins)",
      "type": "select",
      "allowMultiple": true,
      "options": [
        {
          "text": "",
          "value": "-"
        },
        {
          "text": "Success Login",
          "value": "s"
        },
        {
          "text": "Success Exchange",
          "value": "seacft"
        },
        {
          "text": "Success Exchange (Client Credentials)",
          "value": "seccft"
        },
        {
          "text": "Failed Exchange",
          "value": "feacft"
        },
        {
          "text": "Failed Exchange (Client Credentials)",
          "value": "feccft"
        },
        {
          "text": "Failed Login",
          "value": "f"
        },
        {
          "text": "Warnings During Login",
          "value": "w"
        },
        {
          "text": "Deleted User",
          "value": "du"
        },
        {
          "text": "Failed Login (invalid email/username)",
          "value": "fu"
        },
        {
          "text": "Failed Login (wrong password)",
          "value": "fp"
        },
        {
          "text": "Failed by Connector",
          "value": "fc"
        },
        {
          "text": "Failed by CORS",
          "value": "fco"
        },
        {
          "text": "Connector Online",
          "value": "con"
        },
        {
          "text": "Connector Offline",
          "value": "coff"
        },
        {
          "text": "Failed Connector Provisioning",
          "value": "fcpro"
        },
        {
          "text": "Success Signup",
          "value": "ss"
        },
        {
          "text": "Failed Signup",
          "value": "fs"
        },
        {
          "text": "Code Sent",
          "value": "cs"
        },
        {
          "text": "Code/Link Sent",
          "value": "cls"
        },
        {
          "text": "Success Verification Email",
          "value": "sv"
        },
        {
          "text": "Failed Verification Email",
          "value": "fv"
        },
        {
          "text": "Success Change Password",
          "value": "scp"
        },
        {
          "text": "Failed Change Password",
          "value": "fcp"
        },
        {
          "text": "Success Change Email",
          "value": "sce"
        },
        {
          "text": "Failed Change Email",
          "value": "fce"
        },
        {
          "text": "Success Change Username",
          "value": "scu"
        },
        {
          "text": "Failed Change Username",
          "value": "fcu"
        },
        {
          "text": "Success Change Phone Number",
          "value": "scpn"
        },
        {
          "text": "Failed Change Phone Number",
          "value": "fcpn"
        },
        {
          "text": "Success Verification Email Request",
          "value": "svr"
        },
        {
          "text": "Failed Verification Email Request",
          "value": "fvr"
        },
        {
          "text": "Success Change Password Request",
          "value": "scpr"
        },
        {
          "text": "Failed Change Password Request",
          "value": "fcpr"
        },
        {
          "text": "Failed Sending Notification",
          "value": "fn"
        },
        {
          "text": "API Operation",
          "value": "sapi"
        },
        {
          "text": "Failed API Operation",
          "value": "fapi"
        },
        {
          "text": "Blocked Account",
          "value": "limit_wc"
        },
        {
          "text": "Too Many Calls to /userinfo",
          "value": "limit_ui"
        },
        {
          "text": "Rate Limit On API",
          "value": "api_limit"
        },
        {
          "text": "Successful User Deletion",
          "value": "sdu"
        },
        {
          "text": "Failed User Deletion",
          "value": "fdu"
        },
        {
          "text": "Blocked Account",
          "value": "limit_wc"
        },
        {
          "text": "Blocked IP Address",
          "value": "limit_mu"
        },
        {
          "text": "Success Logout",
          "value": "slo"
        },
        {
          "text": "Failed Logout",
          "value": "flo"
        },
        {
          "text": "Success Delegation",
          "value": "sd"
        },
        {
          "text": "Failed Delegation",
          "value": "fd"
        }
      ]
    }
  }
}