How to specify argus.properties after deploying WAR as WEBAPPS in Tomcat

[bhoang-splicemachine]

Experts,

Could you kindly share quick guidance on how I can specify the argus.properties to allow it to access the services with the right ports, after I have deployed the WAR as WEBAPPS in Tomcat?

Thanks!

[saaja-sfdc]

Hi @bhoang-splicemachine , that is accomplished by specifying the location of argus.properties using a runtime java property (-DpropertyName=foo). Please see this wiki entry for more details.

https://github.com/salesforce/Argus/wiki/Getting%20Started#configure-argus

[bhoang-splicemachine]

Thanks @saaja-sfdc

I've followed your guidance and added the -DpropertyName in the CATALINA_OPTS to point to the argus.properties file and can see that it is showing up as part of the tomcat process when doing ps -ef.

However, I'm still seeing the below messages in the catalina.out log:

06:40:49.598 [localhost-startStop-1] INFO com.salesforce.dva.argus.ws.listeners.ArgusWebServletListener - Initializing Argus web services.
[ ^[[1;35mARGUS^[[0;39m | NULLSESSION | NULLUSER | NULLTXID | 2017-03-03 06:40:49.901 | ost-startStop-1 | ^[[31m WARN^[[0;39m ] Unable to load properties file "argus.properties". Reason: argus.properties (No such file or directory)
[ ^[[1;35mARGUS^[[0;39m | NULLSESSION | NULLUSER | NULLTXID | 2017-03-03 06:40:49.906 | ost-startStop-1 | ^[[31m WARN^[[0;39m ] Unable to load properties file "argus.properties". Reason: argus.properties (No such file or directory)

Wondering if you have some idea on where I might have gone wrong.

Thanks in advance!

[saaja-sfdc]

Hi @bhoang-splicemachine ,

For each configurable Argus service, there's two properties in the configuration file, so for say the TSDBService it would look similar to:

service.binding.tsdb=com.salesforce.dva.argus.service.tsdb.SingletonTSDBService
service.config.tsdb=/home/bhoang/argus/config/cachedtsdb.properties

If for the service, you do not specify the service.config.xxx property, it defaults to argus.properties. If that file doesn't exist, you'll get the warning you're seeing in the logs. The easiest way to avoid those warnings, is to specify the service.config.xxx property for each of the configurable services. I'll file an issue to improve the logging so it displays the name of the service which is trying to load properties.

You can always upload your configuration and we can take a look as well.

[bhoang-splicemachine]

Thank you!!

Do I specify the two above properties as part of the java runtime in Tomcat?

i.e. -Dservice.binding.tsdb=com.salesforce.dva.argus.service.tsdb.SingletonTSDBService and -Dservice.config.tsdb=/home/bhoang/argus/config/cachedtsdb.properties

The documentation/wiki mention that the configuration files would be loaded via the two below properties. However, being new to this, I was unable to make sense of where/how we would set them. Could you spare a pointer on this one? Setting these would be equivalent to that of the two above config properties that you referenced?
argus.config.private.location
argus.config.public.location

[saaja-sfdc]

I'll upload a sample tarball of configuration along with the correct JAVA_OPTS setting for tomcat later today. Since this is one of the more frequent questions, I'll be sure to get the wiki updated as well. Stay tuned, I'll keep the issue open until that happens.

[bhoang-splicemachine]

Thanks kindly Tom!!

[saaja-sfdc]

Hi @bhoang-splicemachine,

I've uploaded an extremely basic example of an argus configuration. For the exact configuration parameters available for each service implementation, please refer to the JavaDoc for that implementation (e.g. LdapAuthService implementation of AuthService).

This tarball consists of a config dir with an argus.config file that does two major things:

1. Set some basic system level properties like log level, etc...
2. Binds specific service implementations and specifies the location of the implementation specific configuration file for each service (contained in the /services subdirectory).

In order to load this configuration for Argus web services running in Tomcat, you can either modify the catalina.sh to add the following properties, or add them to the JAVA_OPTS environment variable.

-Dargus.config.private.location=<location_of_your_configdir>/argus.config

Hope that helps!

config.tar.gz

[bhoang-splicemachine]

Super!

Thank you for taking the time to respond and to guide me through this. Sincerely appreciate your expertise and willingness to lend a hand.

I'll get going with this.

Thanks again Tom!

[saaja-sfdc]

My pleasure. Let us know if you have any other questions. I'll keep this issue open until the wiki is updated.

[bhoang-splicemachine]

A quick update, Tom.

Thanks to your sample config and direction, I now have the services configured and running in my environment, and the previous warning messages regarding unable to load the argus.properties file, have been eliminated.

I think I'm at the very last step, getting the final component to work. Though I'm facing an authentication problem when attempting to access Argus services from the browser. I can access other webapps (such as manager and example apps) residing on the same tomcat web service, through the same browser, successfully. However, accessing argus-webservices would return HTTP Status 401 error ("This request requires HTTP authentication").

This area is one which I'm not entirely clear on. I'm not certain whether Argus requires specific authentication settings to be made in the context of webapps/tomcat, or basic authentication to be set up in the tomcat server.

If you have some ideas on this, I would once again appreciate your expertise.

Thank you...

[saaja-sfdc]

Hi @bhoang-splicemachine, If you followed the config example I uploaded, then Argus is configured to use an LDAP identity provider, in which case, you'd have to specify the LDAP specific properties in the AuthService configuration file. If you're not using LDAP and/or are just running it in a local environment for eval/testing, then you can make change the AuthService binding to use NoAuthService implementation instead of LdapAuthService implementation. Just update the argus.config file and change this line:
service.binding.auth=com.salesforce.dva.argus.service.auth.LDAPAuthService
to this
service.binding.auth=com.salesforce.dva.argus.service.auth.NoAuthService
This will essentially tell Argus to circumvent authentication. You will still be required to authenticate when using the UI or web services, but any username or password you type will be accepted. By default when authenticated you will not have administrator privileges when using the NoAuthService implementation. If you do want admin privileges, add the following property to the config/services/ldap.properties
service.property.auth.noauthservice.privileged=true
Really you should probably create a config/services/noauth.properties and specify that as the auth properties file to load (in the argus.config file) and add that property there (since you're not actually using LDAP anymore), but just to get you going, we'll just re-use the existing LDAP properties file and add the property there.
Let me know if you have other questions.

[bhoang-splicemachine]

Thanks Tom!

Let me implement your recommendations and report back.

Really appreciate it...

[bhoang-splicemachine]

Thanks for your patience and pardon my unfamiliarity in the webapps deployment aspect..

I've configured service to be NoAuthService as per your advice.

But for some reason the HTTP Status 401 error "This request requires HTTP authentication", is still haunting me as I attempt to access the endpoints.

I notice NULLUSER messages being reported in the catalina.out log. Not sure if that is the root cause of the HTTP 401 error.

If you have generic/sample web.xml and context.xml that could be shared, I would love to compare and correct mine as necessary.

Sincere thanks...

[bhoang-splicemachine]

Quick update Tom.

It turns out that the endpoints were all working for me. Though one thing I did not have installed was ArgusWeb to provide the front-end UI. One of my colleagues who was more seasoned in the webapps area, helped me out and now the UI is functioning.

[saaja-sfdc]

That's great news @bhoang-splicemachine. If the UI isn't installed you'd have to authenticate using the /auth webservice endpoint prior to making any other webservice calls. This is actually exactly what the UI does. Sounds like you've get everything going, so that's great! I'll keep this open until the wiki get's updated with better instructions for setting everything up.

[dongbin86]

@saaja-sfdc @bhoang-splicemachine
I met the same question，bug I rewrite SystemConfiguration to use a single config file to solve this problem。but, some questions are still here:

I use
service.binding.auth=com.salesforce.dva.argus.service.auth.NoAuthService
service.property.auth.noauthservice.privileged=true
and npm run bundle ArgusWeb module ,put the dist files to webapps，and modify web.xml to add static resource，but it still don't work , 404

[rajsarkapally]

Were you able to reach /help end point? was your web services up and running?

[dilipdevaraj-sfdc]

If the web service is running fine and it is just the UI. Please see https://github.com/salesforce/Argus/tree/develop/ArgusWeb