Get Logger Factory Options

Retrieves the configuration options of a specified logger factory.

HTTP Request

GET /api/sonar/logger-factories/:node_pair_guid/:namespace/:name/options
Request using cURL
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/logger-factories/27102ae5-3698-44d4-aad5-4f2def80f275/local/syslog/options
Request Parameters
KeyRequiredTypeDescriptionNote
node_pair_guidOStringNode pair GUID36 characters
namespaceOStringNamespacelocal or sentry identifier
nameOStringIdentifierE.g. syslog, dirwatch

Success Response

{
  "options": [
    {
      "type": "string",
      "subtype": "ip-range",
      "name": "remote_ip",
      "required": false,
      "display_name": "원격지 IP",
      "description": "원격지 IP 주소 또는 범위, 예를 들면 IP 또는 IP1-IP2 또는 IP/CIDR",
      "default_value": null
    },
    {
      "type": "string",
      "subtype": "port",
      "name": "dst_port",
      "required": false,
      "display_name": "포트",
      "description": "수신 포트 필터(설정하지 않은 경우 모든 포트에 대하여 수신합니다.)",
      "default_value": null
    },
    {
      "type": "string",
      "subtype": null,
      "name": "facility",
      "required": false,
      "display_name": "시스로그 설비 목록",
      "description": "쉼표(`,`)로 구분된 시스로그 설비 번호",
      "default_value": null
    },
    {
      "type": "string",
      "subtype": "regex",
      "name": "date_pattern",
      "required": false,
      "display_name": "날짜 정규표현식",
      "description": "날짜 및 시각을 추출하는데 사용할 정규표현식",
      "default_value": null
    },
    {
      "type": "string",
      "subtype": "date-format",
      "name": "date_format",
      "required": false,
      "display_name": "날짜 포맷",
      "description": "날짜 및 시각 문자열을 파싱하는데 사용할 포맷. 예) yyyy-MM-dd HH:mm:ss",
      "default_value": null
    },
    {
      "type": "string",
      "subtype": "date-locale",
      "name": "date_locale",
      "required": false,
      "display_name": "날짜 로케일",
      "description": "날짜 로케일, 예를 들면 ko",
      "default_value": null
    },
    {
      "type": "string",
      "subtype": "timezone",
      "name": "timezone",
      "required": false,
      "display_name": "시간대",
      "description": "시간대, 예를 들면 KST 또는 Asia/Seoul",
      "default_value": null
    },
    {
      "type": "string",
      "subtype": "regex",
      "name": "regex",
      "required": false,
      "display_name": "정규식 필터",
      "description": "추출할 데이터를 선별할 정규식 패턴",
      "default_value": null
    }
  ]
}
  • options (Array): Options list
    • type (String): Value type. Either string, integer, or boolean.
    • subtype (String): UI rendering hint. Either date-format, date-locale, ip-range, port, regex, or timezone.
    • name (String): Variable name
    • required (Boolean): Whether the option is required
    • display_name (String): Display name
    • description (String): Description
    • default_value (String): Default setting in a logger configuration