Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Logs and diagnostic information

Each service maintains its own set of logs. By default, the logs are maintained in the install_path/hcpcs/log directory on each instance in the system. During installation, you can configure each service to store its logs in a different, non-default location.

Log management

You can manage any of the HCP for cloud scale log files yourself if you want to. That is, you can delete or archive them as necessary.

NoteDeleting log files may make it more difficult for support personnel to resolve issues you may encounter.

System logs are managed automatically in these ways:

  • All log files are periodically added to a compressed file and moved to install_path/hcpcs/retired/. This occurs at least once a day, but can also occur:
    • Whenever you run the log_download script.
    • Hourly, if the system instance's disk space is more than 60% full.
  • When a log file grows larger than 10MB in size, the system stops writing to that file, renames it, and begins writing to a new file. For example, if the file exampleService.log.0 grows too large, it is renamed to exampleService.log.1 and the system creates a new file named exampleService.log.0 to write to.
Retrieving logs and diagnostic information

The tool log_download lets you easily retrieve logs and diagnostic information from all instances in the system. This tool is located at this path on each instance:

install_path/hcpcs/bin/log_download

For information about running the tool, use this command:

install_path/hcpcs/bin/log_download -h

Note
  • When using the tool log_download, if you specify the option --output, do not specify an output path that contains colons, spaces, or symbolic links. If you omit the option --output, you cannot run the script from within a directory path that contains colons, spaces, or symbolic links.
  • When you run the script log_download, all log files are automatically compressed and moved to the directory install_path/hcpcs/retired/.
  • If an instance is down, you need to specify the option --offline to collect the logs from that instance. If your whole system is down, you need to run the script log_download with the option --offline on each instance.
Default log locations

By default, each service stores its logs in its own directory at this path:

install_path/hcpcs/log

This table shows the default log directory names for each service. Depending on how your system was configured when first deployed, your system's logs may not be stored in these directories.

For information about the services, see Services list.

Default log directory nameRelated serviceContains information about
com.hds.ensemble.plugins.service.​adminAppAdmin-AppThe System Management application.
com.hitachi.aspen.foundry.service.​AspenAspenThe HCP for cloud scale application.
com.hds.ensemble.plugins.service.​cassandraDatabase
  • System configuration data.
  • Document fields and values.
com.hds.ensemble.plugins.service.​chronosSchedulingWorkflow task scheduling.
com.hitachi.aspen.foundry.service.​clientaccess.​dataS3-GatewayClient access data service.
com.hds.ensemble.plugins.service.​​elasticsearchMetricsThe storage and indexing of:
  • System events
  • Performance and failure metrics for workflow tasks
com.hds.ensemble.plugins.service.​haproxyNetwork-ProxyNetwork requests between instances.
com.hitachi.aspen.foundry.service.​tracing.​​agentTracing-AgentAgent service
com.hitachi.aspen.foundry.service.tracing.​collectorTracing-CollectorCollector service
com.hitachi.aspen.foundry.service.​tracing.​​queryTracing-QueryQuery service
com.hds.ensemble.plugins.service.​kafkaMessage QueueTransmission of data between instances.
com.hds.ensemble.plugins.service.​logstashLoggingThe transport of system events and workflow task metrics to the Metrics service.
com.hitachi.aspen.foundry.service.​mapi.​gatewayMAPI-GatewayManagement API gateway
com.hds.ensemble.plugins.service.marathonService-DeploymentThe deployment of high-level services across system instances. High-level services are the ones that you can move and configure (such as Index), not the services grouped under System Services.
com.hds.ensemble.plugins.service.​​mesosAgentCluster-WorkerWork ordered by the Cluster-Coordination service.
com.hds.ensemble.plugins.service.​mesosMasterCluster-CoordinationHardware resource allocation.
com.hitachi.aspen.foundry.service.metadata.​policy.​engineMetadata-Policy-EngineMetadata asynchronous policy engine
com.hitachi.aspen.foundry.service.metrics.​prometheusTelemetry-ServiceTelemetry
com.hds.ensemble.plugins.service.​sentinelSentinelInternal system processes.
com.hds.ensemble.plugins.service.​watchdogWatchdogGeneral diagnostic information.
com.hds.ensemble.plugins.service.​zookeeperSynchronizationCoordination of actions and database operations across instances.