What is xo-server-log?

julien-f

xo-server-logs is a small CLI that is installed alongside xo-server which provides a low-level access to the logs in case xo-server is no longer working correctly.

It should be ran with the same access (i.e. OS user) as xo-server itself (i.e. sudo might be necessary), and its documentation is available via xo-server-logs -h.

As I said, it's really low level and not intended for users, don't expect it to be easy to use.

We will improve log management in the future with the new XO tasks and the REST API.

Ascar

@julien-f Thanks for clarification. I understand your warning about these utilities not being intended for users, nevertheless how do I get them installed? I have XO running on Debian, so when I execute apt install xo-server
I get

Building dependency tree... Done
Reading state information... Done
E: Unable to locate package xo-server-logs```

julien-f

@Ascar Are you using Xen Orchestra? Because xo-server-logs is a CLI for it that must be run on the same machine as xo-server is already running.

Ascar

@julien-f Yes, I am working with a VM which has XO installed on it (built from source). When I run xo-server I get the same :

-bash: xo-server: command not found

I have xo-cli v0.19.0

julien-f

@Ascar Ok, how are you running xo-server in your install?

Ascar

@julien-f That's what I was implying to ask - how I am supposed to run it I run it from a command line when I connect to the XO VM via SSH. Am I doing something wrong?

julien-f

@Ascar If you installed XO yourself (following our documentation), you should know how to start XO.

I cannot help you if you don't know how XO was installed on your machine.

Ascar

@julien-f I installed XO myself. The documentation you shared the link for is quite quite helpful. Reading. Thanks.

Ascar

@julien-f Well, I know how to start XO, in fact I don't need to start it as it is always running. I can access XO from browser and everything is good there.

My original question was how to remove entries from backup logs and I did not (and still don't) understand how to issue the xo-server-logs --delete namespace=jobs command while I am in the shell. Can you guide me like I am 1st-grade student?

julien-f

@Ascar Let me retry my previous question: how do you make xo-server start in your install?

Ascar

@julien-f Well, I made a Debian virtual machine, updated it and then followed the instructions on how to build XO from sources. After that I was accessing XO through browser and XO started automatically on VM boot. Until now there was no need for me do anything special in the command line on XO VM. After receiving your previous message I went to /opt/xo/xo-server and executed yarn start and I saw the message saying that the TCP port is already occupied which means that I basically invoked the startup procedure which happens automatically when my VM starts.

julien-f

@Ascar Ok, this is not installing from the sources following the official documentation!! This information would have been useful sooner.

xo-server-logs is available directly in the directory where xo-server is compiled under the name ./dist/logs-cli.mjs.

For more information, please ask directly on the repo you linked.

Ascar

@julien-f Alright, as far as I could understand I would not have gone through this puzzle solving if I had XO built following this guide.

Thank you clearing this out for me. Will make another machine and try again.

julien-f

@Ascar It should be working fine with the other install but the answer to your initial question depends of how you installed XO, therefore my question.

Maybe @ronivay can answer your question.

ronivay

Sure. @Ascar the executable you’re looking for is not called xo-server-logs for the installation done with XenOrchestraInstallerUpdater script. As mentioned above it’s installed beside xo-server as logs-cli.mjs and can be found here (assuming you didn’t change default install location).

$ sudo /opt/xo/xo-server/dist/logs-cli.mjs -h

xo-server-logs --help, -h
…

Help shows command examples as xo-server-logs, but you need to use above executable instead.

You can also easily make xo-server-logs command to work if you wish by running:

sudo ln -s /opt/xo/xo-server/dist/logs-cli.mjs /usr/local/bin/xo-server-logs

But i wouldn’t recommend it if this is needed only once.

Ascar

@ronivay So happy to see you here. Thank you for clarifying my confusion. I did not modify installation paths and I found what I was looking for. logs-cli.mjs does not run by itself and needs node to be prepended. Is this correct? However I made a symlink as you explained and it runs as xo-server-logs directly.

ronivay

That script has a shebang pointing to node (first line), so no need to define it separately, just execute the script directly.