Configure Accounting Options, Source Class Usage and Destination Class Usage Options

You can configure how many days the files are retained in the local directory before they are deleted.

To configure retention for backup files:

• Specify the number of days.

  content_copy zoom_out_map

  [edit accounting-options]
  user@host# set cleanup-interval interval days
  

This value, whether configured or default, applies to all configured files at the [edit accounting-options file] hierarchy level.

To configure the maximum size of the file:

• Specify the size.

  content_copy zoom_out_map

  [edit accounting-options file filename]
  size bytes;
  

The size statement is the maximum size of the log file, in bytes, kilobytes (KB), megabytes (MB), or gigabytes (GB). The minimum value for bytes is 256 KB. You must configure bytes; the remaining attributes are optional.

After a file reaches its maximum size or the transfer-interval time is exceeded, the file is closed, renamed, and, if you configured an archive site, transferred to a remote host.

To configure the sites where files are archived:

• Specify one or more site names.

  content_copy zoom_out_map

  [edit accounting-options file filename]
  user@host# set archive-sites site-name
  

where site-name is any valid FTP URL. For more information about specifying valid FTP URLs, see the Junos OS Administration Library. You can specify more than one URL, in any order. When a file is archived, the router or switch attempts to transfer the file to the first URL in the list, trying the next site in the list only if the transfer does not succeed. The log file is stored at the archive site with a filename of the format router-name_log-filename_timestamp. When you configure file archival by using archive-states statement, the transfer file utility uses the default routing instance to connect to the destination server. If the default routing instance is unable to connect to the destination server, the transfer file utility does not work.

Starting in Junos OS 18.4R1, when you configure file archival by using the archive-sites statement, the transfer file utility does not work if you have enabled the management instance.

You can configure the router to save a copy of the accounting file locally when the normal transfer of the files to the archive site fails. The file is saved to the /var/log/pfedBackup directory of the relevant Routing Engine. You must specify whether only the files from the primary Routing Engine are saved or files are saved from both the primary Routing Engine and the backup (client) Routing Engine.

To configure local backup in the event of failure:

• Specify local backup and which files are saved.

  content_copy zoom_out_map

  [edit accounting-options file filename]
  user@host# set backup-on-failure  (master-and-slave | master-only)
  

Disabling this feature deletes the backed-up accounting files from the directory.

By default, accounting files are transferred in an uncompressed format. To conserve resources during transmission and on the archive site, you can configure compression for the files.

To configure the router to compress accounting files when they are transferred:

• Specify compression.

  content_copy zoom_out_map

  [edit accounting-options file filename]
  user@host# set compress
  

To configure the maximum number of files:

• Specify the number.

  content_copy zoom_out_map

  [edit accounting-options file filename]
  user@host# set files number
  

When a log file reaches its maximum size, it is renamed filename.0, then filename.1, and so on, until the maximum number of log files is reached. Then the oldest log file is overwritten. The minimum value for number is 3 and the default value is 10.

On J Series Services Routers, the files are stored by default on the compact flash drive. Alternatively, you can configure the files to be stored in the mfs/var/log directory (on DRAM) instead of the cf/var/log directory (on the compact flash drive).

To configure the storage location on DRAM:

• Specify nonpersistent storage.

  content_copy zoom_out_map

  [edit accounting-options file filename]
  user@host# set nonpersistent
  

This feature is useful for minimizing read/write traffic on the router’s compact flash drive.

You can configure the router to save the accounting files from the new backup Routing Engine to the new primary Routing Engine when a change in primary role occurs. The files are stored in the /var/log/pfedBackup directory on the router. The primary Routing Engine includes these accounting files with its own current accounting files when it transfers the files from the backup directory to the archive site at the next transfer interval. Configure this option when the new backup Routing Engine is not able to connect to the archive site; for example, when the site is not connected by means of an out-of-band interface or the path to the site is routed through a line card.

To configure the backup Routing Engine files to be saved when primary role changes:

• Specify the backup.

  content_copy zoom_out_map

  [edit accounting-options file filename]
  user@host# set push-backup-to-master
  

To configure the start time for transferring files:

• Specify the time.

  content_copy zoom_out_map

  [edit accounting-options file filename]
  user@host# set start-time YYYY-MM-DD.hh:mm
  

For example, 10:00 a.m. on January 30, 2007 is represented as 2007-01-30.10:00.

To configure the interval at which files are transferred:

• Specify the interval.

  content_copy zoom_out_map

  [edit accounting-options file filename]
  user@host# set transfer-interval minutes
  

The range for transfer-interval is 5 through 2880 minutes. The default is 30 minutes.

An interface profile must specify what statistics are collected. To configure which statistics should be collected for an interface, include the fields statement at the [edit accounting-options interface-profile profile-name] hierarchy level:

[edit accounting-options interface-profile profile-name]
fields {
    field-name;
}

Each accounting profile logs its statistics to a file in the /var/log directory.

To configure which file to use, include the file statement at the [edit accounting-options interface-profile profile-name] hierarchy level:

[edit accounting-options interface-profile profile-name]
file filename;

You must specify a file statement for the interface profile that has already been configured at the [edit accounting-options] hierarchy level.

When you issue the clear interfaces statistics command for a logical interface configured to collect accounting statistics, all accounting statistics received on that interface from the Packet Forwarding Engine are cleared. The current values when the command is issued become the new baseline and the statistics counters are reset to zero. The new values, starting from zero, are displayed in the CLI. However, they are not reported that way in the accounting flat file associated with the interface. Instead, the values as reported in the file continue to increment as if the command had not been issued.

You can change this result by including the allow-clear statement in the interface profile. In this case, when you issue the clear interfaces statistics command, the statistics are reset to zero and reported to the flat file.

To configure reporting of cleared accounting statistics to the flat file, specify reporting:

[edit accounting-options interface-profile profile-name]
 allow-clear;

Each interface with an accounting profile enabled has statistics collected once per interval time specified for the accounting profile. Statistics collection time is scheduled evenly over the configured interval. To configure the interval, include the interval statement at the [edit accounting-options interface-profile profile-name] hierarchy level:

[edit accounting-options interface-profile profile-name]
interval minutes;

The range for the interval statement is 1 through 2880 minutes. The default is 30 minutes.

Configure the interface profile:

[edit]
accounting-options {
    file if_stats {
        size 40 files 5;
    }
    interface-profile if_profile1 {
        file if_stats;
        interval 30;
        fields {
            input-bytes;
            output-bytes;
            input-packets;
            output-packets;
            input-multicast;
            output-multicast;
        }
    }
    interface-profile if_profile2 {
        file if_stats;
        interval 30;
        fields {
            input-bytes;
            output-bytes;
            input-packets;
            output-packets;
            input-multicast;
            output-multicast;
        }
    }
    interfaces {
        xe-1/0/0 {
            accounting-profile if_profile1;
            unit 0 {
                accounting-profile if_profile2;
                ...
            }
        }
    }
}

The two interface profiles, if-profile1 and if-profile2, write data to the same file, if-stats. The if-stats file might look like the following:

#FILE CREATED 976823478 2000-12-14-19:51:18
#hostname host
#profile-layout if_profile2,epoch-timestamp,interface-name,snmp-index,input-bytes,output-bytes,
input-packets,output-packets,input-multicast,output-multicast
#profile-layout if_profile1,epoch-timestamp,interface-name,snmp-index,input-bytes,output-bytes,
input-packets
if_profile2,976823538,xe-1/0/0.0,8,134696815,3681534,501088,40723,0,0
if_profile1,976823538,xe-1/0/0,7,134696815,3681534,501088
...
#FILE CLOSED 976824378 2000-12-14-20:06:18

Statistics are collected for all counters specified in the filter profile. To configure the counters, include the counters statement at the [edit accounting-options filter-profile profile-name] hierarchy level:

[edit accounting-options filter-profile profile-name]
counters {
}

Each accounting profile logs its statistics to a file in the /var/log directory.

To configure which file to use, include the file statement at the [edit accounting-options filter-profile profile-name] hierarchy level:

[edit accounting-options filter-profile profile-name]
file filename;

You must specify a filename for the filter profile that has already been configured at the [edit accounting-options] hierarchy level.

Each filter with an accounting profile enabled has statistics collected once per interval time specified for the accounting profile. Statistics collection time is scheduled evenly over the configured interval. To configure the interval, include the interval statement at the [edit accounting-options filter-profile profile-name] hierarchy level:

[edit accounting-options filter-profile profile-name]
interval;

The range for the interval statement is 1 through 2880 minutes. The default is 30 minutes.

You can configure the class usage profile to collect statistics for particular source and destination classes.

To configure the class usage profile to filter by source classes, include the source-classes statement at the [edit accounting-options class-usage-profile profile-name] hierarchy level:

[edit accounting-options class-usage-profile profile-name]
source-classes {
    source-class-name;
}

To configure the class usage profile to filter by destination classes, include the destination-classes statement at the [edit accounting-options class-usage-profile profile-name] hierarchy level:

[edit accounting-options class-usage-profile profile-name]
destination-classes {
    destination-class-name;
}

Each accounting profile logs its statistics to a file in the /var/log directory.

To specify which file to use, include the file statement at the [edit accounting-options class-usage-profile profile-name] hierarchy level:

[edit accounting-options class-usage-profile profile-name]
file filename;

You must specify a filename for the source class usage profile that has already been configured at the [edit accounting-options] hierarchy level. You can also specify a filename for the destination class usage profile configured at the [edit accounting-options] hierarchy level.

Each interface with a class usage profile enabled has statistics collected once per interval specified for the accounting profile. Statistics collection time is scheduled evenly over the configured interval. To configure the interval, include the interval statement at the [edit accounting-options class-usage-profile profile-name] hierarchy level:

[edit accounting-options class-usage-profile profile-name]
interval;

To create a class usage profile to collect source class usage statistics:

[edit]
accounting-options {
    class-usage-profile scu-profile1;
    file usage-stats;
    interval 15;
    source-classes {
        gold;
        silver;
        bronze;
    }
}

The class usage profile, scu-profile1, writes data to the file usage_stats. The file might look like the following:

#FILE CREATED 976825278 2000-12-14-20:21:18
#profile-layout, scu_profile,epoch-timestamp,interface-name,source-class,
packet-count,byte-count
scu_profile,980313078,xe-1/0/0.0,gold,82,6888
scu_profile,980313078,xe-1/0/0.0,silver,164,13776
scu_profile,980313078,xe-1/0/0.0,bronze,0,0
scu_profile,980313678,xe-1/0/0.0,gold,82,6888
scu_profile,980313678,xe-1/0/0.0,silver,246,20664
scu_profile,980313678,xe-1/0/0.0,bronze,0,0

To create a class usage profile to collect destination class usage statistics:

[edit]
accounting-options {
    class-usage-profile dcu-profile1;
    file usage-stats
    interval 15;
    destination-classes {
        gold;
        silver;
        bronze;
    }
}

The class usage profile, dcu-profile1, writes data to the file usage-stats. The file might look like the following:

#FILE CREATED 976825278 2000-12-14-20:21:18
#profile-layout, dcu_profile,epoch-timestamp,interface-name,destination-class,
packet-count,byte-count
dcu_profile,980313078,xe-1/0/0.0,gold,82,6888
dcu_profile,980313078,xe-1/0/0.0,silver,164,13776
dcu_profile,980313078,xe-1/0/0.0,bronze,0,0
dcu_profile,980313678,xe-1/0/0.0,gold,82,6888
dcu_profile,980313678,xe-1/0/0.0,silver,246,20664
dcu_profile,980313678,xe-1/0/0.0,bronze,0,0
...
#FILE CLOSED 976826178 2000-12-14-20:36:18

Each accounting profile logs its statistics to a file in the /var/log directory.

To configure which file to use, include the file statement at the [edit accounting-options mib-profile profile-name] hierarchy level:

[edit accounting-options mib-profile profile-name]
file filename;

You must specify a filename for the MIB profile that has already been configured at the [edit accounting-options] hierarchy level.

A MIB profile has statistics collected once per interval time specified for the profile. Statistics collection time is scheduled evenly over the configured interval. To configure the interval, include the interval statement at the [edit accounting-options mib-profile profile-name] hierarchy level:

[edit accounting-options mib-profile profile-name]
interval;

The range for the interval statement is 1 through 2880 minutes. The default is 30 minutes.

A MIB profile must specify the operation that is used to collect MIB statistics. To configure which operation is used to collect MIB statistics, include the operation statement at the [edit accounting-options mib-profile profile-name] hierarchy level:

[edit accounting-options mib-profile profile-name]
operation operation-name;

You can configure a get, get-next, or walk operation. The default operation is walk.

A MIB profile must specify the MIB objects for which statistics are to be collected. To configure the MIB objects for which statistics are collected, include the objects-names statement at the [edit accounting-options mib-profile profile-name] hierarchy level:

[edit accounting-options mib-profile profile-name]
object-names {
    mib-object-name;
}

You can include multiple MIB object names in the configuration.

Configure a MIB profile:

[edit accounting-options]
mib-profile mstatistics {
    file stats;
    interval 60;
    operation walk;
    objects-names {
        ipCidrRouteStatus;
    }
}

A Routing Engine profile must specify what statistics are collected. To configure which statistics should be collected for the Routing Engine, include the fields statement at the [edit accounting-options routing-engine-profile profile-name] hierarchy level:

[edit accounting-options routing-engine-profile profile-name]
fields {
    field-name;
}

Each accounting profile logs its statistics to a file in the /var/log directory.

To configure which file to use, include the file statement at the [edit accounting-options routing-engine-profile profile-name] hierarchy level:

[edit accounting-options routing-engine-profile profile-name]
file filename;

You must specify a filename for the Routing Engine profile that has already been configured at the [edit accounting-options] hierarchy level.

A Routing Engine profile has statistics collected once per interval time specified for the profile. Statistics collection time is scheduled evenly over the configured interval. To configure the interval, include the interval statement at the [edit accounting-options routing-engine-profile profile-name] hierarchy level:

[edit accounting-options routing-engine-profile profile-name]
interval;

The range for interval is 1 through 2880 minutes. The default is 30 minutes.

Configure a Routing Engine profile:

[edit accounting-options]
file my-file {
    size 300k;
}
routing-engine-profile profile-1 {
    file my-file;
    fields {
        host-name;
        date;
        time-of-day;
        uptime;
        cpu-load-1;
        cpu-load-5;
        cpu-load-15;
    }
}