REST APIの使用

ObjectCollectionRuleを管理するには、次のAPI操作を使用します:

• ObjectCollectionRuleの作成

• ObjectCollectionRuleの更新

• ObjectCollectionRuleの削除

• ObjectCollectionRuleのリスト

• ObjectCollectionRuleの取得

CLIの使用

CLIの使用の詳細は、コマンドライン・インタフェース(CLI)を参照してください。

CLIコマンドで使用できるフラグおよびオプションの完全なリストは、コマンドライン・リファレンスを参照してください。

ObjectCollectionRuleを管理するには、次のCLIコマンドを実行します:

• ObjectCollectionRuleの作成:

  oci log-analytics object-collection-rule create --from-json <json_file_name> --namespace-name <namespace_name>

  例:

  oci log-analytics object-collection-rule create --from-json file://create.json --namespace-name MyNamespace

  前述のコマンド例で参照されているサンプルのcreate.json:

  {
      "name": "<Rule_Name>",
      "compartmentId": "<Compartment_OCID>",
      "osNamespace": "<Namespace>",
      "osBucketName": "<Bucket_Name>",
      "logGroupId": "<Log_Group_OCID>",
      "logSourceName": "<Log_Source>"
  }

  jsonに次の必須プロパティを指定する必要があります:

  • name: ObjectCollectionRuleに指定された一意の名前。名前はテナンシ内で一意である必要があり、変更できません。
  • compartmentId: ObjectCollectionRuleが配置されているコンパートメントのOCID。
  • osNamespace: オブジェクト・ストレージ・ネームスペース。
  • osBucketName: オブジェクト・ストレージ・バケットの名前。
  • logGroupId: ログ・アナリティクスログ・グループOCIDを記録して、処理済ログを関連付けます。
  • logSourceName: 処理に使用するログ・アナリティクス・ソースの名前。

  必須プロパティに加えて、オプションで次のプロパティも指定できます。

  • collectionType: コレクションのタイプ。指定できる値は、LIVE、HISTORICおよびHISTORIC_LIVEです。
  • charEncoding: 値ISO_8859_1、UTF-16の例
  • definedTags: このリソースの定義済タグ。各キーは事前定義され、ネームスペースにスコープ指定されます。例: {"foo-namespace": {"bar-key": "value"}}
  • 説明: ルールの詳細を説明する文字列(400文字以下)。
  • entityId: 収集されたログが関連付けられているログ・アナリティクス・エンティティのOCID。
  • freeformTags: 事前定義された名前、タイプまたはスコープなしで適用される単純なキーと値のペア。相互互換性専用です。例: {"bar-key": "value"}
  • isEnabled: デフォルトではtrue。
  • objectNameFilters: 例は、オブジェクト名へのフィルタの適用による選択オブジェクト収集の実行を参照してください。
  • オーバーライド: 例は、「特定のオブジェクトを処理するためのObjectCollectionRule構成のオーバーライド」を参照してください。
  • pollSince: RFC3339書式の値2019-10-12T07:20:50.52Zの例。
  • pollTill: RFC3339書式の値2019-10-12T07:20:50.52Zの例。

  ObjectCollectionRuleのプロパティの詳細は、ObjectCollectionRule APIリファレンスを参照してください。

  前述のコマンド例のサンプル・レスポンス:

  {
      "id": "ocid1.loganalyticsobjectcollectionrule.oc1..exampleuniqueID",
      "name": "My Rule",
      "compartmentId": "ocid.compartment.oc1..exampleuniqueID",
      "osNamespace": "MyNamespace",
      "osBucketName": "MyBucket1",
      "collectionType": "LIVE",
      "pollSince": "2020-09-08 14:06:28.028",
      "logGroupId": "ocid1.loganalyticsloggroup.oc1.. exampleuniqueID",
      "logSourceName": "MyLogSource",
      "lifecycleState": "ACTIVE",
      "timeCreated": "2020-09-08T14:06:28.028Z",
      "timeUpdated": "2020-09-08T14:06:28.028Z"
  }

• ObjectCollectionRuleの更新: 次に、ログ・ソースを更新するサンプル・コマンドを示します。同様に、ログ・グループ、エンティティまたはその他のリソースも更新できます。

  oci log-analytics object-collection-rule update --namespace-name <Namespace> --object-collection-rule-id <object-collection-rule-OCID> --log-source-name <Log-Source>

  例:

  oci log-analytics object-collection-rule update --namespace-name “My Namespace” --object-collection-rule-id ocid1.loganalyticsobjectcollectionrule.oc1..exampleuniqueID --log-source-name MyLogSource

• ObjectCollectionRuleの削除:

  oci log-analytics object-collection-rule delete --namespace-name <Namespace> --object-collection-rule-id <object-collection-rule-OCID>

  例:

  oci log-analytics object-collection-rule delete --namespace-name “My Namespace” --object-collection-rule-id ocid1.loganalyticsobjectcollectionrule.oc1..exampleuniqueID

• ObjectCollectionRuleのリスト:

  oci log-analytics object-collection-rule list --namespace-name <Namespace> --compartment-id <compartment-OCID>

  例:

  oci log-analytics object-collection-rule list --namespace-name “My Namespace” --compartment-id ocid.compartment.oc1..exampleuniqueID

• ObjectCollectionRuleの取得:

  oci log-analytics object-collection-rule get --namespace-name <Namespace> --object-collection-rule-id <object-collection-rule-OCID>

  例:

  oci log-analytics object-collection-rule get --namespace-name “My Namespace” --object-collection-rule-id ocid1.loganalyticsobjectcollectionrule.oc1..exampleuniqueID

• ObjectCollectionRuleへのオーバーライドの追加:

  ObjectCollectionRuleがすでに存在する場合は、ObjectCollectionRuleに追加するオーバーライド条件を使用して、オーバーライドjson (たとえば、update_override.json)を作成します:

  {
    "overrides":{"items":[{"matchType":"contains","matchValue":"audit","propertyName":"logSourceName","propertyValue":"myLOGANAuditSource"}]} 
  }

  次に、ObjectCollectionRuleを更新して、オーバーライドを含めます:

  oci log-analytics object-collection-rule update --namespace-name <Namespace> --object-collection-rule-id <object-collection-rule-OCID> --from-json file://path-to/file

  例:

  oci log-analytics object-collection-rule update --namespace-name “My Namespace” --object-collection-rule-id ocid1.loganalyticsobjectcollectionrule.oc1..exampleuniqueID --from-json file:///scratch/update_override.json

  ObjectCollectionRuleでのオーバーライドの詳細は、特定のオブジェクトを処理するためのObjectCollectionRule構成のオーバーライドを参照してください。

• ObjectCollectionRuleからのオーバーライドの削除:

  ObjectCollectionRuleからすべてのオーバーライド条件を削除する場合は、次のようにオーバーライド・プロパティの詳細を示すjson (たとえば、remove_overrides.json)を作成します:

  {
    "overrides":{"items":[]} 
  }

  次に、ObjectCollectionRuleを更新します:

  oci log-analytics object-collection-rule update --namespace-name <Namespace> --object-collection-rule-id <object-collection-rule-OCID> --from-json file://path-to/file

  例:

  oci log-analytics object-collection-rule update --namespace-name “My Namespace” --object-collection-rule-id ocid1.loganalyticsobjectcollectionrule.oc1..exampleuniqueID --from-json file:///scratch/remove_overrides.json

  ObjectCollectionRuleでのオーバーライドの詳細は、特定のオブジェクトを処理するためのObjectCollectionRule構成のオーバーライドを参照してください。

• objectNameFiltersをObjectCollectionRuleに追加:

  ObjectCollectionRuleがすでに存在する場合は、ObjectCollectionRuleに追加するオブジェクト名に対するフィルタを使用して、フィルタjson (たとえば、filters.json)を作成します:

  {
    "objectNameFilters":["a/*","*audit*"]
  }

  ノート
  
  既存のObjectCollectionRuleをObjectNameFiltersで更新できるのは、LIVEまたはHISTORIC_LIVE型の場合のみです。タイプHISTORICはこの操作ではサポートされていません。

  次に、ObjectCollectionRuleを更新してフィルタを含めます:

  oci log-analytics object-collection-rule update --namespace-name <Namespace> --object-collection-rule-id <object-collection-rule-OCID> --from-json file://path-to/file

  例:

  oci log-analytics object-collection-rule update --namespace-name “My Namespace” --object-collection-rule-id ocid1.loganalyticsobjectcollectionrule.oc1..exampleuniqueID --from-json file:///scratch/filters.json

  ObjectCollectionRuleのフィルタの詳細は、オブジェクト名へのフィルタの適用による選択オブジェクト収集の実行を参照してください。

ゲスト・テナントに追加するポリシー

次に、ホスト・テナントHost_TenantのIAMグループHost_User_GroupおよびOracle Logging Analyticsサービスがゲスト・テナンシのゲスト・コンパートメントGuest_Compartmentのオブジェクトにアクセスできるようにするポリシー・ステートメントの例を示します:

define group <Host_User_Group> as <Host_User_Group_OCID>
define tenancy <Host_Tenant> as <Host_Tenant_OCID>
admit group <Host_User_Group> of tenancy <Host_Tenant> to use buckets in compartment <Guest_Compartment>
allow service loganalytics to read buckets in compartment <Guest_Compartment>
allow service loganalytics to read objects in compartment <Guest_Compartment>
allow service loganalytics to manage cloudevents-rules in compartment <Guest_Compartment>
allow service loganalytics to inspect compartments in tenancy
allow service loganalytics to use tag-namespaces in tenancy where all {target.tag-namespace.name = /oracle-tags /}

ホスト・テナントに追加するポリシー

次に、ホストIAMグループHost_User_Groupがゲスト・テナンシGuest_Tenantのバケットに対してUSEアクセス権を持つことを許可するポリシー・ステートメントの例を示します:

define tenancy <Guest_Tenant> as <Guest_Tenant_OCID>
endorse group <Host_User_Group> to use buckets in tenancy <Guest_Tenant>
allow group <Host_User_Group> to use loganalytics-object-collection-rule in compartment <Rule_Compartment>
allow group <Host_User_Group> to {LOG_ANALYTICS_LOG_GROUP_UPLOAD_LOGS} in compartment <LogGroup_Compartment>
allow group <Host_User_Group> to {LOG_ANALYTICS_SOURCE_READ} in tenancy

オプションで、ObjectCollectionRuleにエンティティが関連付けられている場合は、このポリシーを定義します:

allow group <Host_User_Group> to {LOG_ANALYTICS_ENTITY_UPLOAD_LOGS} in compartment <Entity_Compartment>

前述のポリシーで、

• Rule_Compartment: ObjectCollectionRuleを作成する必要があるコンパートメント。

• LogGroup_Compartment: ログを格納する必要があるOracle Logging Analyticsログ・グループのコンパートメント。

• Entity_Compartment: Oracle Logging Analyticsエンティティのコンパートメント。

必要なポリシーが作成されたら、ObjectCollectionRuleを作成して、ゲスト・テナンシのオブジェクト・ストレージからログを収集できます。次の例に示すように、JSONファイルでゲスト・テナントのネームスペースosNamespaceおよびバケット名osBucketNameを指定します:

{
 "name": "<My_Rule>",
 "compartmentId": "<Compartment_OCID>",
 "osNamespace": "<Guest_Tenant_Namespace>", // Namespace of the guest tenant
"osBucketName": "<Guest_Tenant__Bucket1>", // Bucket in the guest tenant object store namespace
"logGroupId": "<Log_Group_OCID>",
 "logSourceName": "<My_Log_Source>"
 }

ObjectCollectionRuleの作成の詳細は、ObjectCollectionRuleの操作を参照してください。