system_information(3erl) Erlang Module Definition system_information(3erl)
NAME
system_information - System Information
DESCRIPTION
EXPORTS
sanity_check() -> ok | {failed, Failures}
Types:
Application = atom()
ApplicationVersion = string()
MissingRuntimeDependencies =
{missing_runtime_dependencies, ApplicationVersion,
[ApplicationVersion]}
InvalidApplicationVersion =
{invalid_application_version, ApplicationVersion}
InvalidAppFile = {invalid_app_file, Application}
Failure =
MissingRuntimeDependencies | InvalidApplicationVersion |
InvalidAppFile
Failures = [Failure]
Performs a sanity check on the system. If no issues were found,
ok is returned. If issues were found, {failed, Failures} is re-
turned. All failures found will be part of the Failures list.
Currently defined Failure elements in the Failures list:
InvalidAppFile:
An application has an invalid .app file. The second element
identifies the application which has the invalid .app file.
InvalidApplicationVersion:
An application has an invalid application version. The sec-
ond element identifies the application version that is in-
valid.
MissingRuntimeDependencies:
An application is missing runtime dependencies. The second
element identifies the application (with version) that has
missing dependencies. The third element contains the missing
dependencies.
Note that this check use application versions that are
loaded, or will be loaded when used. You might have applica-
tion versions that satisfies all dependencies installed in
the system, but if those are not loaded this check will
fail. The system will of course also fail when used like
this. This may happen when you have multiple branched ver-
sions of the same application installed in the system, but
you do not use a boot script identifing the correct applica-
tion version.
Currently the sanity check is limited to verifying runtime de-
pendencies found in the .app files of all applications. More
checks will be introduced in the future. This implies that the
return type will change in the future.
Note:
An ok return value only means that sanity_check/0 did not find
any issues, not that no issues exist.
to_file(FileName) -> ok | {error, Reason}
Types:
FileName = file:name_all()
Reason = file:posix() | badarg | terminated | system_limit
Writes miscellaneous system information to file. This informa-
tion will typically be requested by the Erlang/OTP team at Eric-
sson AB when reporting an issue.
Ericsson AB runtime_tools 1.15 system_information(3erl)