# SYSLOG

## 1. 機能概要

本製品は、稼働状況を把握する仕組みとして、以下に示すSYSLOG機能を提供します。

1. ログを本製品の内部に蓄積し、参照、削除する機能

2. ログ蓄積と同じタイミングでコンソールに出力する機能

3. ログ蓄積と同じタイミングであらかじめ登録した通知先（SYSLOGサーバー）に送信する機能

ログの蓄積、コンソールへの出力、SYSLOGサーバーへの通知は、ユーザーが設定した出力レベルに従って行われます。許可されたメッセージのみが処理の対象となります。
ログの蓄積は、RAM上で行われ、Flash ROMに対して自動でバックアップ、またはコマンドにより手動でバックアップすることが可能です。
手動バックアップ時にSDカードに同時にバックアップすることも可能です。
SYSLOGサーバーへの通知は、ログ蓄積と同じタイミングで行われますが、SYSLOGサーバーの登録が行われている場合に限定されます。

## 2. 用語の定義

特になし

## 3. 機能詳細

SYSLOG機能について、以下に示します。

1. ログの蓄積は、RAMに対して行われ、最大で10000件蓄積可能とします。
   Flash ROMへのバックアップは、以下の手段によって行うことができます。

   - システム起動から1時間ごとに行う自動バックアップ

   - save logging コマンドによる手動バックアップ

   - write コマンドの実行に成功した際に行われるバックアップ

2. 蓄積したログは、 show logging コマンドにより参照することが可能です。
   また、 clear logging コマンドにより削除することが可能です。
   なお、 show logging コマンドは、RAMの情報を表示します。
   本製品のログ情報は、RAMと Flash ROMの情報は、必ず一致していることが前提となります。
   （システム起動時、Flash ROMのログ情報をRAMに展開し、サービスを開始します。また、バックアップ実行後、RAMのログ情報は、消去しません。）

3. ログの送信は、通知先（SYSLOGサーバー）の登録が行われている場合に限り、機能します。
   通知先は、 logging host コマンドで2つまで登録できます。
   通知先の指定は、IPアドレス、またはFQDNで行います。
   通知先のポート番号は、デフォルトポート番号である514を使用します。（ユーザーが任意に設定することはできません）
   通知するログのファシリティー値は、 logging facility コマンドで設定可能です。工場出荷時は、local0(16)が設定されています。
   通知するログのフォーマットは、 logging format コマンドでヘッダー部（タイムスタンプ、ホスト名）なしに変更できます。ログの例を以下に示します。

   - format 指定なし (no logging format)

         <134>Jan  1 00:00:00 Yamaha [     IMI]:inf: Configuration file is saved in "config0"

   - format 指定あり (logging format legacy)

         <134>[     IMI]:inf: Configuration file is saved in "config0"

4. 送信するログのレベル（SYSLOGのプライオリティ）は、 logging trap コマンドで設定可能です。
   本製品では、ログのレベルごとに出力の有効・無効設定が可能です。
   工場出荷時の出力レベルは、Informational、Errorのみを有効にします。

5. logging backup sd コマンドにより、SDカードへのSYSLOGバックアップを有効にすることが可能です。
   SDカードへのSYSLOGバックアップが有効なとき、 save logging コマンドを実行すると、SDカード内に日付入りログファイルが保存されます。

## 4. 関連コマンド一覧

関連コマンドについて、以下に示します。
詳細は、コマンドリファレンスを参照願います。

機能名 | コマンド名
ログの出力レベル設定 | logging trap
ログのコンソール出力設定 | logging stdout
ログの通知先 (SYSLOGサーバ) 設定 | logging host
ログの通知フォーマット変更 | logging format
ログのバックアップ | save logging
ログの削除 | clear logging
ログの参照 | show logging
ログのSDカードバックアップの設定 | logging backup sd
ログのファシリティー値の設定 | logging facility

## 5. コマンド設定例

1. Debugレベルのログ出力を有効して、ファシリティー値10でSYSLOGサーバー（192.168.1.100）にログ出力を開始します。
   さらにInformationalレベルのログをコンソールに出力します。

       Yamaha(config)# logging trap debug (1)
       Yamaha(config)# logging facility 10 (2)
       Yamaha(config)# logging host 192.168.1.100 (3)
       Yamaha(config)# logging stdout info (4)

   1 | Debugレベルのログ出力を有効にする
   2 | ファシリティー値を10に設定する
   3 | SYSLOGサーバーの登録
   4 | Informationalレベルのログをコンソールに出力する

2. SYSLOGサーバーへの通知を終了します。

       Yamaha(config)# no logging host

3. 蓄積されているログ情報を保存し、表示します。

       Yamaha# save logging (1)
       Yamaha# show logging (2)
       2018/03/08 20:42:46: [ SESSION]:inf: Login succeeded as (noname) for HTTP: 192.168.1.40
       2018/03/09 10:06:42: [     NSM]:inf: Interface port1.11 changed state to down
       2018/03/09 10:09:48: [ SESSION]:inf: Logout timer expired as (noname) from HTTP: 192.168.1.40
       2018/03/09 16:19:36: [     NSM]:inf: Interface port1.17 changed state to up
        :

   1 | RAM上のログをROMに保存する
   2 | 蓄積されているログを表示する

4. 蓄積されているログ情報を削除します。

       Yamaha# clear logging (1)
       Yamaha# show logging (2)
        (3)

   1 | 蓄積されているログを全て削除する
   2 | ログを表示する
   3 | 消去したため、何も表示されない

## 6. 注意事項

特になし

## 7. 関連文書

特になし

Search result
No more search results.
There are no topics that match your search query.