1system_information(3)      Erlang Module Definition      system_information(3)
2
3
4

NAME

6       system_information - System Information
7

DESCRIPTION

EXPORTS
10       sanity_check() -> ok | {failed, Failures}
11
12              Types:
13
14                 Application = atom()
15                 ApplicationVersion = string()
16                 MissingRuntimeDependencies =
17                     {missing_runtime_dependencies,
18                      ApplicationVersion,
19                      [ApplicationVersion]}
20                 InvalidApplicationVersion =
21                     {invalid_application_version, ApplicationVersion}
22                 InvalidAppFile = {invalid_app_file, Application}
23                 Failure =
24                     MissingRuntimeDependencies |
25                     InvalidApplicationVersion |
26                     InvalidAppFile
27                 Failures = [Failure]
28
29              Performs  a sanity check on the system. If no issues were found,
30              ok is returned. If issues  were  found,  {failed,  Failures}  is
31              returned.  All failures found will be part of the Failures list.
32              Currently defined Failure elements in the Failures list:
33
34                InvalidAppFile:
35                  An application has an invalid .app file. The second  element
36                  identifies the application which has the invalid .app file.
37
38                InvalidApplicationVersion:
39                  An  application has an invalid application version. The sec‐
40                  ond element  identifies  the  application  version  that  is
41                  invalid.
42
43                MissingRuntimeDependencies:
44                  An  application  is missing runtime dependencies. The second
45                  element identifies the application (with version)  that  has
46                  missing dependencies. The third element contains the missing
47                  dependencies.
48
49                  Note that this  check  use  application  versions  that  are
50                  loaded, or will be loaded when used. You might have applica‐
51                  tion versions that satisfies all dependencies  installed  in
52                  the  system,  but  if  those  are not loaded this check will
53                  fail. The system will of course also  fail  when  used  like
54                  this.  This  may happen when you have multiple branched ver‐
55                  sions of the same application installed in the  system,  but
56                  you do not use a boot script identifing the correct applica‐
57                  tion version.
58
59              Currently the sanity  check  is  limited  to  verifying  runtime
60              dependencies  found  in the .app files of all applications. More
61              checks will be introduced in the future. This implies  that  the
62              return type will change in the future.
63
64          Note:
65              An  ok  return value only means that sanity_check/0 did not find
66              any issues, not that no issues exist.
67
68
69       to_file(FileName) -> ok | {error, Reason}
70
71              Types:
72
73                 FileName = file:name_all()
74                 Reason = file:posix() | badarg | terminated | system_limit
75
76              Writes miscellaneous system information to file.  This  informa‐
77              tion will typically be requested by the Erlang/OTP team at Eric‐
78              sson AB when reporting an issue.
79
80
81
82Ericsson AB                  runtime_tools 1.13.2        system_information(3)



        

    


            
        

        

            Impressum