COmanage Developers List

[Scott Koranda <>]

FYI...

----- Forwarded message from Scott Koranda 
<>
 -----

Date: Mon, 19 Feb 2018 16:16:53 -0600
From: Scott Koranda 
<>
To: 

Subject: Campus Success component logging requirements

Hi,

Regarding the component logging requirements coming out of the TIER
Campus Success Meeting...

On last week's call we learned that the desired format is

ComponentName, LogfileName, Env, UserDefinedEnvironmentVar

where Env is one of Prod, Dev, or Test and any dot in a LogfileName
should be replaced by a '-'.

I have some followup questions:

1) What are the official ComponentName values? Is it just simply

COmanage Registry
Grouper
Shibboleth IdP

?

2) Can you remind me why a dot in the LogfileName is to be replaced by a
'-'?

3) Is the value for Env intended to be injected into the container at
run time? If so, is there a standard we want to use for how that is
done?

For example, for COmanage I would probably define an environment
variable to be injected at run time

COMANAGE_REGISTRY_RUNTIME_ENVIRONMENT

so for example in a Docker compose file I would have 

- COMANAGE_REGISTRY_RUNTIME_ENVIRONMENT=Test

I would probably have that defined by default in the image as 'Prod',
and I would probably also make it so that it can be injected at build
time. Is that a reasonable approach?

4) Is there any guidance on how the UserDefinedEnvironmentVar is to be
set? 

I can imagine for COmanage Registry again having an environment variable
to be injected at container start up like

COMANAGE_REGISTRY_DEPLOYER_ENV_VAR_VALUE

so the Docker compose file might have

- COMANAGE_REGISTRY_DEPLOYER_ENV_VAR_VALUE=foo_bar

which would cause the value 'foo_bar' to show up in log lines for the
field UserDefinedEnvironmentVar.

Is that the approach that was envisioned?

5) I would like to work from an example. Consider the COmanage Registry
'error.log' file. If COmanage Registry was just deployed "by hand" then
a typical line in the file might be

ERROR: OrgIdentitySource 3 : No route to host

Is this then a valid example of how that same line would appear in the
Docker logs emitted by the container:

COmanage Registry error-log Prod foo_bar ERROR: OrgIdentitySource 3 : No 
route to host

?

Thanks,

Scott K

----- End forwarded message -----