To achieve this, after SPM client is installed, open /opt/spm/properties/spm-sender.properties file and just add desired hostname to the value of property spm_sender_hostname_alias, e.g. spm_sender_hostname_alias=web1.production.

After that, restart SPM monitor with:

sudo service spm-monitor restart

and restart any Java process which was using javaagent/in-process version of SPM monitor.

Few notes to keep in mind:

• you can do this change at any point, even after SPM client was running on your machine for the past few months or years - you just have to upgrade SPM client to version 1.17.7 or greater
• old data will still be seen in SPM under the old hostname, while new data (after hostname change) will be displayed under the new hostname
• if you are installing SPM client on some machine for the first time, and you want to be 100% sure its original hostname never leaves your network, define your hostname alias in spm-sender.properties file immediately after you complete "1. Package installation" step and before you begin with "2. Client configuration setup" step (Installation instructions can be accessed from https://apps.sematext.com/ui/monitoring, click Actions->Install Monitor on app you are installing)

Can I reduce the amount of logs generated by SPM monitor

A: Yes, starting with 1.20.6 version of SPM client you can make SPM monitor reduce the number of messages it logs every minute (otherwise it logs detailed info about its monitoring lifecycle). To do that, change properties files of your SPM applications. You can find those files with:

ls /opt/spm/spm-monitor/conf/spm-monitor-config-*.properties

You can adjust one or more of them, depending on which application's monitor log output you want to reduce. At the bottom of those files add the following line:

SPM_MONITOR_LOGGING_LEVEL=reduced

After you have made the changes, restart your SPM monitor – if you are using standalone variant, run: sudo service spm-monitor restart , otherwise restart your application/java process.

How frequently does SPM monitor collects metrics and can I adjust that interval

SPM monitor by default collects metrics every 10 seconds. To reduce this frequency to 30 seconds, for example, simply add the following line to your SPM monitor properties files located in /opt/spm/spm-monitor/conf :

SPM_MONITOR_COLLECT_INTERVAL=30000

The value is expressed in milliseconds. If you are adjusting it, we recommend setting it to 30000. With bigger values it is possible some 1-minute intervals would be displayed without the data in the UI.

After you make this change, make sure SPM monitor is restarted (if using in-process monitor, restart the monitored services; if using standalone monitor, just run sudo service spm-monitor restart).

How much memory is standalone SPM monitor using and can it be adjusted

By default, each standalone SPM monitor process is started with "-Xmx384m" setting. This means that its JVM heap will use 384 MB at most. In many cases SPM monitor doesn't actually need or use that much memory. If you want to be absolutely sure about it, simply lower this number in /opt/spm/spm-monitor/bin/spm-monitor-starter.sh, with the following variable (around line 63):

JAVA_OPTIONS="$JAVA_OPTIONS -Xmx384m -Xms128m -Xss256k"

You can change "-Xmx" part to "-Xmx192m" for example and see how it goes (check if SPM monitor is still working over the next few hours/days and is still not using much CPU).

We don't recommend changing this setting if you are monitoring Elasticsearch or Solr clusters with a high number of indices or shards. In those cases SPM monitor has to parse and gather large amounts of metrics data returned by Elasticsearch or Solr.  You can contact us in chat or via email (spm-support@sematext.com) if you'd like to get more info and help around making this adjustment.

Can I use SPM to monitor multiple applications running on the same server / VM

A: Yes. There are really 2 different scenarios here:

1) If each of those applications should be monitored under a different SPM application (e.g., you could have Solr running on your server along with some Java app and you want to monitor both - Solr would be monitored with SPM application of Solr or SolrCloud type, while the Java app would be monitored with SPM application of JVM type), just complete all installation steps from http(which are accessible from https://apps.sematext.com/spm-reports/client.doui/monitoring, click Actions->Install Monitor for app you are installing) for each of them separately.

2) If you want them monitored under the same SPM application (e.g., you have 3 Solr instances running on a server), you must use different JVM name for each of them. To do this, "1. Package installation" step on http://apps.sematext.com/spm-reports/client.do should should be run only once on this machine, while "2. Client configuration setup" step should be run once for each of the 3 Solr instances . When running script (installation instructions are accessible from https://apps.sematext.com/ui/monitoring, click Actions->Install Monitor for app you are installing). When running script /opt/spm/bin/spm-client-setup-conf.sh in step "2. Client configuration setup", you should add jvmname parameter (and value) at the end of parameter list, like this:

sudo bash /opt/spm/bin/spm-client-setup-conf.sh 11111111-1111-1111-1111-111111111111 solr javaagent jvmname:solr1

In this example, we are setting up things for 3 separate Solr processes, monitored under JVM names: solr1, solr2 and solr3 (you choose any names), so this is adjusted command for solr1 instance.

In the remaining sub-steps of "2. Client configuration setup", replace word "default" with the jvmname value you just used.

"2. Client configuration setup" step will have to be repeated N times, once for each monitored application (in our example 3 times with 3 different jvmname values).

Note: By using this kind of setup, you will be able to see JVM stats of all 3 processes separately (JVM name filter is used to do the filtering). When it comes to other, non-JVM stats, they will be aggregated into single value (for instance, request rate chart will show sum of request rate value of these 3 Solr instances). If you want to see even non-JVM stats separately, you will have to create 3 separate SPM Solr applications (one for each Solr instance running on this machine).

Can I use SPM to monitor my service which runs on Windows or Mac OS X

A: SPM client installers currently exist only for Linux, however there is still a way to monitor your service. If you are OK with installing SPM client on separate linux box, and pointing it (more about that further below) to your service (which should be monitored) running on Windows or Mac, you can use SPM to monitor all non-OS related metrics. That means you will not be able to see CPU or system Memory metrics, but metrics specific to your process will be displayed (for example, in case of Solr, you will see all search, index, cache metrics along with all JVM metrics like pool memory, GC stats, JVM threads etc; as another example, in case of MySQL you will see all metrics related to connections, users, queries, handlers, commands, MyISAM, InnoDB, MySQL traffic, etc) .

When monitoring Solr, Elasticsearch, HBase, Hadoop and other Java-based services, you will have an option to choose between using In-process (javaagent) or Standalone monitor. The workaround described here requires the use of standalone monitor variant. Here's what you'd need to do to see your metrics in SPM:

1. Install spm-client on any Linux box (you can use this box for anything else, it is needed here just to run a process which collects metrics and sends them to Sematext), following steps from http. Installation instructions are accessible from https://apps.sematext.com/spm-reports/client.do . ui/monitoring, just click Actions->Install Monitor for app are installing. In step 1 choose the "Other" tab to create a minimal installation.  This will not install modules needed for monitoring OS metrics - if those modules were installed, they would collect OS metrics of your Linux box, which is probably something you don't need. If you decide to follow instructions from some other tab, keep in mind OS metrics displayed in SPM UI will not be OS metrics of your Windows/Mac machine.
2. In step 2, if you are given a choice between In-process and Standalone monitor, choose Standalone monitor. It will use remote JMX to collect metrics from your Windows/Mac machine. Just follow instructions given on Standalone tab.  The only difference you will want to make is in -Dspm.remote.jmx.url parameter used in monitor properties.  You will know where to adjust it if you follow standard instructions for Standalone monitor. While this parameter will usually have a value like -Dspm.remote.jmx.url=localhost:3000, in this case you will have to replace localhost with the address of your Windows/Mac machine(s) by which it can be reached from your helper Linux box.
3. If you are monitoring something that doesn't offer a choice between In-process and Standalone monitor, installation instructions at http://apps.sematext.com/spm-reports/client.do will explain where you can define your own address. Instructions typically use localhost, but you can instead use something like 10.1.2.3 or my-win-solr-server.mycompany.com to point to the machine that hosts the service you intend to monitor.

In case you want to monitor multiple machines belonging to the same cluster in this way, you can still use SPM installed on a single Linux helper box. Just do this:

• Create a separate SPM application in SPM UI (https://apps.sematext.com/spm-reports/registerApplication.doui/integrations) for each of the machines which should be monitored
• For each of those SPM applications (and your monitored machines), go through installation process described in httppresented after the app was created (installation instructions are accessible from https://apps.sematext.com/spm-reports/client.doui/monitoring, just click Actions->Install Monitor for app your are installing). Note: Since each SPM application uses its own token, they all have slightly different installation commands. Besides different token, you will also use different addresses of Windows/Mac machines that host the monitored service.

Can SPM monitor metrics via http-remoting-jmx protocol (e.g. WildFly, JBoss, etc.)

Yes. The following steps are needed:

1. In /opt/spm/spm-monitor/conf/spm-monitor-config-YOUR_TOKEN-default.rt look for a line similar to this (the file name might be a bit different, depending on app type you have chosen):

   Code Block
   SPM_MONITOR_JAR="/opt/spm/spm-monitor/lib/spm-monitor-jvm.jar"

   Replace this line with something like the following (e.g. in case of WildFly adjust the path depending on where your WildFly is installed, like /opt/wildfly/bin/client/jboss-cli-client.jar):

   Code Block
   SPM_MONITOR_JAR="/opt/spm/spm-monitor/lib/spm-monitor-jvm.jar:/path/to/your/jboss-cli-client.jar"

   
   

2. Change the value of SPM_MONITOR_JMX_PARAMS in /opt/spm/spm-monitor/conf/spm-monitor-config-YOUR_TOKEN-default.properties. Of course, you can append to that additional JMX parameters, for example with password file location etc:

   Code Block
   SPM_MONITOR_JMX_PARAMS="-Dspm.remote.jmx.url=service:jmx:http-remoting-jmx://localhost:9990"

   
   

3. Restart spm-monitor with: sudo service spm-monitor restart

At this point the metrics will start appearing in charts. If they don't, run the diagnostics script (sudo bash /opt/spm/bin/spm-client-diagnostics.sh) to get fresh output of errors. If you see errors similar to:

Caused by: javax.security.sasl.SaslException: Authentication failed: all available authentication mechanisms failed:

java.io.FileNotFoundException: /opt/wildfly/standalone/tmp/auth/local8363680782928117445.challenge (Permission denied)

javax.security.sasl.SaslException: DIGEST-MD5: Cannot perform callback to acquire realm, authentication ID or password [Caused by javax.security.auth.callback.UnsupportedCallbackException

When should I run Standalone and when Embedded SPM monitor

A: Standalone SPM monitor runs as a separate process, while Embedded monitor runs embedded in the Java/JVM process.  Thus, if you are monitoring a non-Java application, Standalone monitor is the only option.  Standalone monitor is a bit more complex to set up when one uses it to monitor Java applications because it typically requires one to enable out-of-process JMX access, as described on Standalone SPM monitor page.  With Embedded monitor this is not needed, but one needs to add the SPM agent to the Java command-line and restart the process of the monitored application.  When running Standalone monitor one can update the SPM monitor without restarting the Java process being monitored, while a restart is needed when Embedded SPM monitor is being used.  To be able to trace transactions or database operations you need to use the Embedded SPM monitor.

Can I use SPM for (business) transaction tracing

A: Yes, see Transaction Tracing.

Can I move SPM client to a different directory

A: Yes. Starting with version 1.22.25, SPM client provides two scripts that can be used to move SPM client files/directories to another location:

1) Soft move script - Moves all SPM files/directories to a new location, but symlinks /opt/spm to the new location. Use this script if you are OK with having /opt/spm symlinked. This script is recommended for most situations since it keeps your SPM client installation completely in line with standard setup (all standard SPM client commands and arguments are still valid).

It accepts 1 parameter: new directory where SPM client should be moved to (if such directory doesn't exist, it will be created)

sudo bash /opt/spm/bin/move-spm-home-dir-soft.sh /mnt/some_dir

And that is it.

2) Full move script - Moves all SPM files/directories to a new location without leaving any SPM artifacts in /opt directory. Please note that using this script will make management of SPM client a bit harder (for example, there will be some required actions before running SPM client upgrade; also, if you are using in-process (javaagent) type of monitor you will need to adjust some paths in java arguments - more about that below).

It accepts 2 parameters: the current location (by default /opt/spm), and the new location (if such directory doesn't exist, it will be created). It can be run as:

sudo bash /opt/spm/bin/move-spm-home-dir.sh /opt/spm /mnt/some_other_dir/spm

If you are using in-process (javaagent) versions of SPM monitor to monitor Java-based applications, please adjust agent path(s) you use when starting application(s) you monitor with the SPM agent and make sure to use new location where old location was used before. Also add the following argument to the monitored application's Java process (you can add it right before -javaagent part; adjust the value to match directory you used):

-Dspm.home=/mnt/some_other_dir/spm

I am using SPM for Solr and I don't see any data only in Solr Components or Errors reports, what should I do

A: Most likely you are using standalone variant of Solr monitor. In that case, SPM monitor can't collect metrics which are available only when running in-process. If so, switch to in-process (javaagent) version of SPM monitor.

Upgrading

How do I upgrade the SPM client

A: If you have previously installed the SPM client package (RPM, Deb, etc.) as described on https://apps.sematext.com/spm-reports/client.do simply , simply upgrade via apt-get (Debian, Ubuntu, etc.), or yum (RedHat, CentOS, etc.), or zypper (SuSE).

Debian/Ubuntu:

wget -O - https://pub-repo.sematext.com/ubuntu/sematext.gpg.key | sudo apt-key add -  # NOTE: this will update the sematext gpg key
sudo apt-get update && sudo apt-get install spm-client  # NOTE: this does not update the whole server, just spm-client

RedHat/CentOS/...

sudo wget https://pub-repo.sematext.com/centos/sematext.repo -O /etc/yum.repos.d/sematext.repo  # NOTE: this will update sematext repo file
sudo yum clean all && sudo yum update spm-client        # NOTE: this does not update the whole server, just spm-client

SuSE:

sudo zypper up spm-client

After that is done, also do:

• if you are using SPM monitor in in-process/javaagent mode - restart monitored server (restart your Solr, Elasticsearch, Hadoop node, HBase node... Exceptions: In case of Memcached, Apache and plain Nginx - no need to restart anything; in case of Redis only standalone SPM monitor exists so check below how to restart it)

OR

• if you are using standalone SPM monitor, restart it with:
  
  

sudo service spm-monitor restart

If you used bash script based installer, then just run the installation command again ("curl -ko installer.sh ...." or "wget --no-check-certificate -O installer.sh ..."). There is no need to go through "Client configuration setup" steps from https://apps.sematext.com/spm-reports/client.do since since the existing configuration will be preserved.

After that is done, next step is the same as with apt-get/yum/zipper upgrade - you should restart monitored server (if using in-process/javaagent monitor) or standalone SPM monitor.

Note: In case of Memcached, Apache and plain Nginx - after completing upgrade steps described above, you must also run commands described in Step 2 - Client Configuration Setup from (which is accessible from https://apps.sematext.com/spm-reports/client.doui/monitoring, click Actions->Install Monitor for app you have installed)

Note: If you moved SPM client from /opt/spm to different directory, you will first have to move SPM back to original /opt/spm directory:

sudo bash /opt/spm/bin/move-spm-home-dir.sh /mnt/some_other_dir/spm /opt/spm

and then proceed with regular update. After update is done, you can again move SPM client to location which suits you.

Uninstalling

How do I uninstall the SPM client

A: On servers where you want to uninstall the client do the following:

1. remove spm-client, for instance: sudo apt-get purge spm-client   OR   sudo yum remove spm-client
2. after that, ensure there are no old logs, configs, etc. by running the following command: sudo rm -R /opt/spm
3. if you used in-process (javaagent) version of monitor, remove "-javaagent" definition from startup parameters of process which was monitored

Note: in case you used installer described on "Other" tab on http(found on https://apps.sematext.com/spm-reports/client.doui/monitoring, click Actions->Install Monitor for app your are installing), instead of commands from step 1 run: sudo bash /opt/spm/bin/spm-client-uninstall.sh . After that proceed with steps 2 and 3 described above.

Security

What information are SPM agents sending

A: SPM agents are sending metrics and data used for filtering those metrics, such as hostnames (which can be obfuscated).  To see what exactly is being sent you can use tcpdump or a similar tool to sniff the traffic.  SPM agents ship data via HTTPS, but can also ship it via HTTP.  Java-based agents let you change the protocol in appropriate files under /opt/spm/spm-sender/conf/ directory, while Node.js-based agents let you change it via the SPM_RECEIVER_URL environmental variable.

Billing

How exactly is usage metered for billing purposes

A: Usage is metered hourly per-server-per-app. For example:

How do you bill for monitoring of Docker containers.

A: Docker monitoring is based on the base price and per-container price.  The base price includes monitoring of a Docker host and free monitoring of up to N containers. Per-container price is applied only if you run more than N containers per host.  The number of containers per host is averaged for the whole account.  The base price and the number of containers included in it depends on the plan.  Note that monitoring of Docker host and containers is independent of monitoring of applications you run in those containers.  Containerized applications monitored by SPM are metered as separate hosts. In other words, whether the monitored application is running in a container or in a VM or directly on a server or in a public cloud instance is the same as far as metering and billing is concerned. For plans and price details see https://sematext.com/spm/#plans-and-pricing.

Which credit cards are accepted

A: We accept all major credit cards - Visa, MasterCard, American Express, JCB, Discover, and Diners Club.  We can also invoice you if you want to pay via ACH or bank wires.

Can I be invoiced instead of paying with a credit card

A: Yes, we offer a pre-payment option through invoicing.  When you select this option simply email us and let us know how much you want to pre-pay.  If you want that credit to cover some period of time you'll want to consider how many apps/servers/containers you need to monitor, whether they are running 24/7, and which plan(s) you'd like.  We'll invoice you and, once we receive your payment, we'll enter this amount as credit towards your Sematext account.  This amount will then be burned down, based on your usage, on a monthly basis.  We'll notify you before your balance gets too low, so that we can repeat the invoicing process before your credit runs out.

How often will I get billed

A: We bill on a monthly basis and send an email to notify you of the amount.

Can the billing email be sent to our Accounts Payable/Accounting instead of me

A: Yes, when you select your plan and payment method you will also be able to enter an alternative billing email address.  Also, search this FAQ for information about BILLING_ADMIN role.

Do I have to commit or can I stop using SPM at any time

A: There is no commitment and no contract. When/if you want to stop using SPM you simply stop sending us your metrics and/or switch to the Free plan.

Can I get invoices

A: Yes, just log in and look under Account > Billing >  Invoices.  If you don't see invoices there then you likely need to switch to a different account.  To do that look for a pull-down menu at the top-right of the UI.