メインコンテンツまでスキップ
Sumo Logic Japanese

Hosted Source の JSON パラメータ

このトピックでは、Hosted Collector の JSON Source パラメータについて説明します。詳細については以下のトピックを参照してください。

Hosted Collector の Source タイプ

各 Source には、「JSON を使用した Source の設定」の汎用フィールドに加えて、固有のフィールドを定義できます。sourceType フィールドは、Source タイプ (および関連パラメータ) を指定します。有効なフィールド タイプを下表に示します。表の下のセクションでは、各 Source に固有のパラメータと関連する JSON ファイルの例を示します。

Google Cloud Platform と G Suite Apps の監査 Source は JSON では作成できません。これらの Source では手動の 0Auth 検証が必要であり、Sumo Web インターフェイスでのみサポートされます。

Hosted log Sources

フィールド タイプ タイプ値
HTTP Source HTTP
クラウド Syslog Source Cloudsyslog
Amazon S3 Source ポーリング
AWS Elastic Load Balancing Source ポーリング
AWS CloudFront Source ポーリング
AWS CloudTrail Source ポーリング
AWS S3 Audit Source ポーリング
AWS メタデータ (タグ) ソース ポーリング

ホスト メトリクス Source

フィールド タイプ タイプ値
AWS CloudWatch Source ポーリング

Hosted Collector 用のログ Source パラメータ

HTTP Source

共通パラメータに加えて、HTTP Source では以下のパラメータも使用できます。

パラメータ タイプ 必須 デフォルト 説明 アクセス
sourceType 文字列 はい   HTTP 変更不可
messagePerRequest ブール はい   true に設定すると、各 HTTP リクエストに対して 1 つのメッセージのみが送信されます。この機能を無効にするには false に設定してください。 

messagePerRequest を「true に設定する場合は、共通パラメータの multilineProcessingEnabledfalse に設定してください。
変更可
url 文字列 不可 Sumo が Source に割り当てる URL Source の固有 HTTP エンドポイント Web アドレスです。 変更不可

HTTP Source JSON の例: 

{
    "api.version": "v1",
    "source": {
        "sourceType": "HTTP",
        "name": "Example1",
        "messagePerRequest": true,
        "multilineProcessingEnabled": false
    }
}

クラウド Syslog Source

共通パラメータに加えて、クラウド syslog Source では以下のパラメータも使用できます。

パラメータ タイプ 必須 デフォルト 説明 アクセス
sourceType 文字列 はい   Cloudsyslog 変更不可

クラウド syslog Source JSON の例: 

{
   "api.version":"v1",
   "source":{
      "sourceType":"Cloudsyslog",
      "name":"Example1"
   }
}

AWS ログ Source

共通パラメータに加えて、AWS ログ Source では以下のパラメータも使用できます。

パラメータ タイプ 必須 デフォルト 説明 アクセス
sourceType 文字列 はい   ポーリング 変更不可
contentType 文字列 不可   作成する AWS Source に基づいて定義してください。

S3:                              AwsS3Bucket
S3 Audit:                 AwsS3AuditBucket
CloudFront:          AwsCloudFrontBucket
CloudTrail:             AwsCloudTrailBucket
ELB:                           AwsElbBucket
メタデータ:               AwsMetadata
変更不可
scanInterval Long はい  300000 新しいデータを S3 バケットでスキャンする間隔をミリ秒単位で指定します。最小値:  1000

自動に設定する場合: -1
変更可
paused ブール はい false true に設定すると、S3 バケット項目のスキャナーが一時停止します。無効にするには false に設定してください。 変更可
url 文字列 不可 Sumo が Source に割り当てる URL AWS でイベント ベースの通知をセットアップします。この値は、Source の作成時に Sumo によって作成されて割り当てられます。 変更不可
thirdPartyRef ネスト化 JSON はい   サードパーティ統合に必要なすべての情報 (s3 バケット名、S3 オブジェクトのパス式、アクセス資格情報など) を指定します。

IAM ユーザ認証の例:

"authentication": {
  "type": "S3BucketAuthentication",
  "awsId": "AKIAIOSFODNN7EXAMPLE",
  "awsKey": "*******"
}


IAM ロール認証の例:

"authentication": {
  "type": "AWSRoleBasedAuthentication",
  "roleARN": "arn:aws:iam::123456789012:role/myrole"
}
変更可
snsTopicOrSubscriptionArn

このパラメータは、ネスト化 JSON の thirdPartyRef で使用します。
文字列 不可   SNS トピック/サブスクリプション ARN。SNS が正しく設定されてサブスクリプション確認リクエストを受け取ると、isSuccess は true に設定されます。

   "thirdPartyRef": {
        "resources": [{
            "serviceType": "#",
            "path": {
                "type": "#",
                "bucketName": "#",
                "pathExpression": "*",
                "snsTopicOrSubscriptionArn": {
                    "isSuccess": true,
                    "arn": "arn:aws:sns:#:#:SumoSNSTopic-#:#"
                }
            },
            "authentication": {...
            }
        }]
    }
変更不可
bucketName

このパラメータは、ネスト化 JSON の thirdPartyRef で使用します。
文字列 はい   AWS S3 バケットの名前。 変更可
pathExpression

このパラメータは、ネスト化 JSON の thirdPartyRef で使用します。
文字列 はい   収集する S3 オブジェクトと一致するワイルドカード パターン。  変更可

Amazon S3 Source

この Source のパラメータについては、「AWS ログ Source」を参照してください。Amazon S3 Source JSON の例: 

{
  "api.version":"v1",
  "source":{
    "sourceType": "Polling",
    "name": "Example1",
    "contentType": "AwsS3Bucket",
    "thirdPartyRef":{
      "resources":[
        {
          "serviceType": "AwsS3Bucket",
          "path": {
            "type": "S3BucketPathExpression",
            "bucketName": "Bucket1",
            "pathExpression": "*"
          },
          "authentication": {
            "type": "AWSRoleBasedAuthentication",
            "roleARN": "arn:aws:iam::123456789012:role/myrole"
          }
        }    
      ]
    },
    "scanInterval": 300000,
    "paused": false
  }
}

AWS Elastic Load Balancing Source

この Source のパラメータについては、「AWS ログ Source」を参照してください。AWS Elastic Load Balancing Source JSON の例: 

{
    "api.version": "v1",
    "source": {
        "sourceType": "Polling",
        "name": "Example1",
        "contentType": "AwsElbBucket",
        "thirdPartyRef": {
            "resources": [{
                "serviceType": "AwsElbBucket",
                "path": {
                    "type": "S3BucketPathExpression",
                    "bucketName": "Bucket1",
                    "pathExpression": "*"
                },
                "authentication": {
                    "type": "AWSRoleBasedAuthentication",
                    "roleARN": "arn:aws:iam::123456789012:role/myrole"
                }
            }]
        },
        "scanInterval": 300000,
        "paused": false
    }
}

AWS CloudFront Source

この Source のパラメータについては、「AWS ログ Source」を参照してください。AWS CloudFront Source JSON の例: 

{
    "api.version": "v1",
    "source": {
        "sourceType": "Polling",
        "name": "Example1",
        "contentType": "AwsCloudFrontBucket",
        "thirdPartyRef": {
            "resources": [{
                "serviceType": "AwsCloudFrontBucket",
                "path": {
                    "type": "S3BucketPathExpression",
                    "bucketName": "Bucket1",
                    "pathExpression": "*"
                },
                "authentication": {
                    "type": "AWSRoleBasedAuthentication",
                    "roleARN": "arn:aws:iam::123456789012:role/myrole"
                }
            }]
        },
        "scanInterval": 300000,
        "paused": false
    }
}

AWS CloudTrail Source

この Source のパラメータについては、「AWS ログ Source」を参照してください。AWS CloudTrail Source JSON の例: 

{
    "api.version": "v1",
    "source": {
        "sourceType": "Polling",
        "name": "Example1",
        "contentType": "AwsCloudTrailBucket",
        "thirdPartyRef": {
            "resources": [{
                "serviceType": "AwsCloudTrailBucket",
                "path": {
                    "type": "S3BucketPathExpression",
                    "bucketName": "Bucket1",
                    "pathExpression": "*"
                },
                "authentication": {
                    "type": "AWSRoleBasedAuthentication",
                    "roleARN": "arn:aws:iam::123456789012:role/myrole"
                }
            }]
        },
        "scanInterval": 300000,
        "paused": false
    }
}

Amazon S3 Audit Source

この Source のパラメータについては、「AWS ログ Source」を参照してください。AWS S3 監査 Source JSON の例: 

{
    "api.version": "v1",
    "source": {
        "sourceType": "Polling",
        "name": "Example1",
        "contentType": "AwsS3AuditBucket",
        "thirdPartyRef": {
            "resources": [{
                "serviceType": "AwsS3AuditBucket",
                "path": {
                    "type": "S3BucketPathExpression",
                    "bucketName": "Bucket1",
                    "pathExpression": "*"
                },
                "authentication": {
                    "type": "AWSRoleBasedAuthentication",
                    "roleARN": "arn:aws:iam::123456789012:role/myrole"
                }
            }]
        },
        "scanInterval": 300000,
        "paused": false
    }
}

AWS メタデータ (タグ) ソース

この Source のパラメータについては、「AWS ログ Source」を参照してください。AWS メタデータ Source JSON の例: 

{
    "api.version": "v1",
    "source": {
        "sourceType": "Polling",
        "name": "exampleName",
        "description": "Poll metadata for data",
        "automaticDateParsing": false,
        "multilineProcessingEnabled": false,
        "useAutolineMatching": false,
        "contentType": "AwsMetadata",
        "forceTimeZone": false,
        "filters": [],
        "cutoffTimestamp": 0,
        "encoding": "UTF-8",
        "fields": {

        },
        "thirdPartyRef": {
            "resources": [{
                "serviceType": "AwsMetadata",
                "path": {
                    "type": "AwsMetadataPath",
                    "limitToRegions": ["ap-southeast-2", "us-east-1", "us-west-2"],
                    "limitToNamespaces": ["AWS/EC2"],
                    "tagFilters": ["tag1", "tag2", "tag3", "tag4", "name"]
                },
                "authentication": {
                    "type": "AWSRoleBasedAuthentication",
                    "roleARN": "arn:aws:iam::123456789012:role/myrole"
                }
            }]
        },
        "scanInterval": 60000,
        "paused": false
    }
}

Hosted Collector 用のメトリクス Source パラメータ

AWS CloudWatch Source

以下のパラメータは AWS CloudWatch Source で使用します。

パラメータ タイプ 必須 デフォルト 説明 アクセス
name 文字列 はい   Source の名前を入力します。名前は Collector ごとに一意でなければなりません。この値はメタデータ_source フィールドに割り当てられます。 変更可
description 文字列 不可 null Source の説明を入力します。 変更可
カテゴリ 文字列 不可 null Source のカテゴリを入力します。この値はメタデータ_sourceCategory フィールドに割り当てられます。詳細については、「ベスト プラクティス」を参照してください。 変更可
sourceType 文字列 はい   ポーリング 変更不可
contentType 文字列 不可   AwsCloudWatch 変更不可
scanInterval Long はい  300000 新しいデータを S3 バケットでスキャンする間隔をミリ秒単位で指定します。

最小値:  1000
変更可
paused ブール はい false true に設定すると、メトリクスのスキャナーが一時停止します。無効にするには false に設定してください。 変更可
thirdPartyRef ネスト化 JSON はい   サードパーティ統合に必要なすべての情報 (関連する Amazon リージョン、名前空間、アクセス資格情報など) を指定します。 変更可

AWS CloudWatch Source JSON の例: 

{
   "api.version":"v1",
   "source":{
      "sourceType": "Polling",
      "name": "Example1",
      "contentType": "AwsCloudWatch",
      "thirdPartyRef":{
         "resources":[
            {
               "serviceType": "AwsCloudWatch",
               "path": {
                  "type": "CloudWatchPath",
                  "limitToRegions": ["region-1", "region-2"],
                  "limitToNamespaces": ["AWS/ELB", "AWS/Route53", "AWS/OpsWork"]
               },
               "authentication": {
                  "type": "S3BucketAuthentication",
                  "awsId": "AKIAIOSFODNN7EXAMPLE",
                  "awsKey": "*******"
               }
            }
         ]
      },
      "scanInterval": 300000,
      "paused": false
   }
}
  • この記事は役に立ちましたか?