ConfD API を使用したログのフィルタリング

ConfD API に導入されたログフィルタを使用して、ESC でログ（展開ログやエラーログなど）を照会および取得できます。テナント、展開名、および VM 名の新しいフィルタが導入されました。これにより、ConfD API のログフィルタを使用して、最新のエラーログの ESC ログをさらに照会することができます。ESC と OS 間の通信に関連する ESC ログを取得することもできます（分類タグを「OS」に設定します）。

次に、ConfD API ログを取得するためのログ形式を示します。

date=<time-date>] [loglevel=<loglevel>] [tid=<transactionid>] [cl=<classifications>] [tags=<tags>] [msg=<message>

次に、サンプルログの例を示します。

date=15:43:58,46022-Nov-2016] [loglevel=ERROR ] [tid=0793b5c9-8255-47f3-81e6-fbb59f6571f7] [cl=OS ]  
[tags=wf:create_vm,eventType:VM_DEPLOY_EVENT,tenant:test,depName:test-dep,vmGrpName:test-VNF,
vmName:test-dep_test_0_dc3f406c-05ca-43b3-af21-0841e3b029a0] 
[msg=sleepingfor5seconds to allow vm to become ACTIVE instance id: 162344f7-78f9-4e45-9f23-34cf87377fa7 name:test-dep_test_0_dc3f406c-05ca-43b3-af21-0841e3b029a0 

ログレベル、分類、およびタグのパラメータは、ログを取得するために相互に依存します。次の組み合わせを使用してログを正常に取得できます。

• log_level=ERROR, classifications=OS, tags=(depName:test-dep)

• log_level=ERROR, classifications=OS, tags=(tenant: test)

ログフィルタは、次の条件がすべて満たされたときに値を返します。

• ログ レベル

• 分類（指定されている場合）

• タグ（指定されている場合）

（注）	複数の分類がリストされている場合は、1 つ以上の分類に一致する必要があります。同じことが、タグにも適用されます。

たとえば、次のログフィルタ条件では、前述のログサンプルを返しません。

log_level=ERROR, classifications=VIM, tags=(depName:test-dep)

ログレベルとタグが一致していても、分類の VIM が一致していないので値は返されません。

次に、データモデルを示します。

rpc filterLog {
    description "Query and filter escmanager logs using given parameters";
    tailf:actionpoint escrpc;
    input {
      leaf log_level {
        mandatory false;
        description "One of DEBUG / INFO / WARNING / ERROR / TRACE / FATAL. Results will include all logs at and
                     above the level specified";
        type types:log_level_types;
        default ERROR;
      }
      leaf log_count {
        mandatory false;
        description "Number of logs to return";
        type uint32;
        default 10;
      }
      container classifications {
        leaf-list classification {
          description "Classification values to be used for the log filtering.  For example: 'OS', 'SM'.
                      Logs containing any of the provided classification values will be returned.";
          type types:log_classification_types;     
        }
      }
      container tags {
        list tag {
          key "name";
          leaf name {
            mandatory true;
            description "Tag name to be used for the log filtering.  For example: 'tenant', 'depName'.
                         Logs containing any of the provided tag name plus the tag values will be returned.";
            type types:log_tag_types;
          }
          leaf value {
            mandatory true;
            description "Tag value pairs to be used for the log filtering.  For example: 'adminTenant', 'CSRDeployment'";
            type string;
          }
        }
      }
    }
    output {
      container filterLogResults {
        leaf log_level {
          description "Log level used to filter for the logs.";        
          type types:log_level_types;
        }
        list logs {
          container classifications {
            leaf-list classification {
              description "Classifications used to filter for the logs.";
              type types:log_classification_types;
            }
          }
          container tags {
            list tag {
              key "name";
              leaf name {
                mandatory true;
                description "Tag name used to filter for the logs.";
                type types:log_tag_types;
              }
              leaf value {
                mandatory true;
                description "Tag value used to filter for the logs.";
                type string;
              }
            }
          }
          leaf log_date_time {
            description "Timestamp of the log.";
            type string;
          }
          leaf log_message {
            description "The log message.";
            type string;
          }
        }
      }
    }
  }
   

NETCONF コンソールまたは esc_nc_cli を使用して、ConfD API ログを照会できます。

• NETCONF コンソールを使用して、次のクエリを実行します。

  /opt/cisco/esc/confd/bin/netconf-console --port=830 --host=127.0.0.1 --user=admin --privKeyFile=/home/admin/.ssh/confd_id_dsa --privKeyType=dsa --rpc=log.xml

• esc_nc_cli を使用して、次のクエリを実行します。

  esc_nc_cli --user <username> --password <password> filter-log log.xml

  次に、log.xml の例を示します。

  <filterLog xmlns="https://www.cisco.com/esc/esc">
    <log_level>INFO</log_level>
    <log_count>1</log_count>
    <classifications>
      <classification>OS</classification>
      <classification>SM</classification>
    </classifications>
    <tags>
      <tag>
        <name>depName</name>
        <value>CSR_ap1</value>
      </tag>
      <tag>
        <name>tenant</name>
        <value>admin</value>
      </tag>
    </tags>
  </filterLog>
  

  応答は次のとおりです。

  <rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="1">
    <filterLogResults xmlns="https://www.cisco.com/esc/esc">
      <log_level>INFO</log_level>
      <logs>
        <classifications>
          <classification>OS</classification>
          <classification>SM</classification>
        </classifications>
        <tags>
          <tag>
            <name>depName</name>
            <value>CSR_ap1</value>
          </tag>
          <tag>
            <name>tenant</name>
            <value>admin</value>
          </tag>
        </tags>
        <log_date_time>13:06:07,575 31-Oct-2016</log_date_time>
        <log_message> No pending work flow to start.</log_message>
      </logs>
    </filterLogResults>
  </rpc-reply>

  （注）	ロギング API の応答は XML 形式です。ログメッセージに XML 文字が含まれている場合はその文字がエスケープされるため、XML 準拠は解除されません。