How to get Client IP Address in Access Logs

Summary

Determine the client IP address from which REST API requests against Bamboo originate since currently neither the <bamboo-install>/logs/access_log or <bamboo-install>/logs/catalina.out provide this information.

The following appears in the <bamboo-install>/logs/catalina.out:

The following appears in the <bamboo-install>/logs/access_log:

Diagnosis

Diagnostic Steps

1. Install Bamboo and set it up behind Apache

   VirtualHost

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 <Virtualhost *:80> ServerName webserver.bamboo ProxyRequests Off ProxyPreserveHost On <Proxy *> Order deny,allow Allow from all </Proxy> ProxyPass / http://localhost:8085/ ProxyPassReverse / http://localhost:8085/ <Location /> Order allow,deny Allow from all </Location> </Virtualhost>

2. Add ServerName to /etc/hosts or C:\Windows\System32\drivers\etc\hosts on the Bamboo server, e.g. 192.168.0.12

   /etc/hosts (Linux/MacOS), C:WindowsSystem32driversetchosts (Windows)

   1 127.0.0.1 webserver.bamboo

3. Add ServerName to /etc/hosts or C:\Windows\System32\drivers\etc\hosts on a different server, e.g. 192.168.0.15

   /etc/hosts (Linux/MacOS), C:WindowsSystem32driversetchosts (Windows)

   1 192.168.0.12 webserver.bamboo

4. Create a new Project / Plan with Repository and add a branch.

5. Log out and navigate to the following URL in a web browser: http://webserver.bamboo/rest/api/latest/plan/PROJ-PLAN/branch.json from the same server where Bamboo is running, e.g. 192.168.0.12

6. Log out and navigate to the following URL in a web browser: http://webserver.bamboo/rest/api/latest/plan/PROJ-PLAN/branch.json from the other server, e.g. 192.168.0.15

7. Both requests are presented in the Bamboo logs as 127.0.0.1 where we would expect the individual client IPs 192.168.0.12 (same server) or 192.168.0.15 (different server)

Cause

In the <bamboo-install>/conf/server.xml you can find the following entry that describes what Bamboo will capture and write to the logs:

<bamboo-install>/conf/server.xml

There is a value missing: %{X-Forwarded-For}i

Refer to http://httpd.apache.org/docs/2.2/mod/mod_proxy.html for further information.

Solution

In order to have Bamboo log the client IP Address:

1. Stop Bamboo.

2. Prepend the missing value to <bamboo-install>/conf/server.xml to the front of the existing value of the "pattern" attribute within the "Valve" tag:

   <bamboo-install>/conf/server.xml

   1 2 3 <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" prefix="access_client_ip." suffix=".log" pattern="&quot;%{X-Forwarded-For}i&quot; %l %u %t %r %s %b &quot;%{User-Agent}i&quot; &quot;%{Referer}i&quot;" resolveHosts="false"/>

3. Start Bamboo

Test

Redo steps 5 & 6 from the Diagnostic Steps above and note the difference in the logs:

<bamboo-install/logs/access_client_ip>