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



        

    


            
        

        

            Impressum